As the creators and maintainers of this project, we want to ensure that the project lives, continues to grow and evolves. The evolution of the project should never be blocked by any single person's time. One of the simplest ways of doing this is by encouraging a larger set of shallow contributors. Through this, we hope to mitigate the problems of a project that needs updates but there's no-one who has the power to do so.
It's important to note that this repository has a Code of Conduct. So, please follow it in all your interactions with the project.
Here is a quick guide for doing code contributions to the project.
-
Find some issue you're interested in or a feature that you'd like to tackle. Make sure that no one else is already working on it. We don't want you to be disappointed.
-
Discuss the change you wish to make via issue with the maintainers before making a change.
-
Fork, then clone:
git clone https://github.com/YOUR_USERNAME/plataforma-sabia.git -
Create a branch with a meaningful name for the issue:
git checkout -b fix-something -
Follow the README file instructions in order to install the dependencies and run the project locally.
-
Make your changes and commit:
git addandgit commitRemember that we have a pre-commit hook that lints the code to prevent mistakes.
-
Make sure the tests still pass:
npm run test(in order to run the api tests) ornpm run jest(for running the web package tests). -
Push your branch:
git push -u origin your-branch-name -
Submit a pull request to the upstream repository.
-
Choose a descriptive title and describe your changes briefly.
-
Wait for a maintainer to review your PR, make changes if it's being recommended, and get it merged.
-
Celebrate! 🎉
These contribution guidelines are based on https://github.com/moya/contributors. Big thanks to @alloy, @orta et al. for the inspiration and guidance.
Thank you to all the people who have already contributed to plataforma-sabia!