|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [developer.tapio.one](https://developer.tapio.one) ✨. |
| 4 | + |
| 5 | +Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. |
| 6 | + |
| 7 | +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. |
| 8 | + |
| 9 | +## New contributor guide |
| 10 | + |
| 11 | +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: |
| 12 | + |
| 13 | +- [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) |
| 14 | +- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) |
| 15 | +- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) |
| 16 | +- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) |
| 17 | + |
| 18 | +## Issues |
| 19 | + |
| 20 | +### Create a new issue |
| 21 | + |
| 22 | +If you spot a problem with the docs, [search if an issue already exists](https://github.com/tapioone/docs/issues). If a related issue doesn't exist, you can open a new issue. |
| 23 | + |
| 24 | +### Solve an issue |
| 25 | + |
| 26 | +Scan through our [existing issues](https://github.com/tapioone/docs/issues) to find one that interests you. If you find an issue to work on, you are welcome to open a PR with a fix! |
| 27 | + |
| 28 | +#### Make Changes |
| 29 | + |
| 30 | +1. Install the correct node version (see `package.json`). |
| 31 | +2. Clone the repository `git clone https://github.com/tapioone/docs.git`. |
| 32 | +3. Install all dependencies `npm install`. |
| 33 | +4. Start the development server `npm run start`. |
| 34 | +5. Make your changes. |
| 35 | + |
| 36 | +#### Commit your update |
| 37 | + |
| 38 | +Commit the changes once you are happy with them. Please adhere to the [conventional commits standard](https://www.conventionalcommits.org/en/v1.0.0/) for naming your commits. |
| 39 | + |
| 40 | +#### Pull Request |
| 41 | + |
| 42 | +When you're finished with the changes, create a pull request, also known as a PR. |
| 43 | + |
| 44 | +- Don't forget to [link your PR to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. |
| 45 | +- Once you submit your PR, a friendly bot will kindly ask you to sign our [CLA](https://github.com/tapioone/cla). |
| 46 | +- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. |
| 47 | +- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). |
| 48 | +- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues. |
0 commit comments