Thank you for investing your time in contributing to our project! ✨.
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
We communicate primarily on Element App,to join our communication channels:
If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open one.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters.
- Fork the repository.
- Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo.
- Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
-
Install or update to Node.js, at the version specified in
.node-version. For more information, see the development guide. -
Create a working branch and start with your changes!
Commit the changes once you are happy with them.:zap:.
When you're finished with the changes, create a pull request, also known as a PR. Send a Pull request to the development branch.
Congratulations 🎉🎉 The Health Stack team thanks you ✨.