Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on developer.tapio.one ✨.
Read our Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
Scan through our existing 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!
- Install the correct node version (see
package.json). - Clone the repository
git clone https://github.com/tapioone/docs.git. - Install all dependencies
npm install. - Start the development server
npm run start. - Make your changes.
Commit the changes once you are happy with them. Please adhere to the conventional commits standard for naming your commits.
When you're finished with the changes, create a pull request, also known as a PR.
- Don't forget to link your PR to an issue if you are solving one.
- Once you submit your PR, a friendly bot will kindly ask you to sign our CLA.
- We may ask for changes to be made before a PR can be merged, either using suggested changes 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.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.