wehub-resource-sync
24 lines
1.6 KiB
Markdown
24 lines
1.6 KiB
Markdown
# Contributing
|
|
|
|
Thank you for investing your time in contributing to our project!
|
|
|
|
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
|
|
|
|
## New contributor guide
|
|
|
|
To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
|
|
|
|
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
|
|
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
|
|
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
|
|
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
|
|
|
|
## Getting started
|
|
|
|
1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) and [clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) the [repository](https://github.com/cisa/redeye)
|
|
2. [Create a separate branch](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/managing-branches) for your changes
|
|
3. Make your changes, and ensure that it is formatted by [Prettier](https://prettier.io) and lint-checks without errors in [ESLint](https://eslint.org)
|
|
4. Create a changeset by running `yarn changeset`. [More info](https://github.com/atlassian/changesets).
|
|
5. You can run tests locally to validate changes with `yarn run test`. [More info](https://www.cypress.io).
|
|
6. Push your branch and open a PR 🚀
|