Welcome! Thank you for being willing and taking the time to contribute to the cause🎉.
Below is a set of guidelines for contributing to the Say-Their-Name/web repo in the Say-Their-Name organization.
This project is run by a community of volunteers. The community communicates via a slack workspace, and to-dos are maintained on respective Trello boards.
- If you would like to join the Slack workspace, use this link.
- If you would like to join the Trello board, use this link.
Please, keep discussions in issues and pull requests positive, productive, and respectful. We're all humans afterall.
The main branch is development, where all ongoing development work converges. master branch is reserved for some more finished version of the app.
To get all setup, fork this repo and do all of your work there.
When working on something, create a new branch from development, and make a PR back into the development branch in the main repo.
There are multiple people working from different timezones, so it's good to try to keep your branch up-to-date by rebasing it on top of latest development.
Try to not let your work get stale and out of date. The best approach is to make smaller PRs: for example, laying some foundation for a feature, or refactoring, can be PR'd before continuing further with feature development.
Before making a PR, ensure all files are linted according to our eslint configuration and tests pass locally(not yet setup, but soon).
When making a PR, add a meaningful title and description. And fill the auto-generated PR template as best as you can.
If any development is done on the UI (additions or non-trivial changes), please include a screenshot of the change.
Tag Say-Their-Name/web group as a reviewer, so all web contributors get a notification.
Create a new issue to report bugs and propose features if a similar issue has not already been opened.
When opening a new issue for a bug, add a title and a clear description with code samples or an executable test case demonstrating the issue.
- React
- Styled Components
- React Router
- React Testing Library
Almost all of the code you'll touch in this codebase will be JavaScript.
The intention is to keep the amount of third-party dependencies to a minimum. However, it's better to add a dependency rather than write or copy over untested code. If in doubt, don't hesitate to consult with the community - there is usually a reasonable solution :)
Please refer to the README
Hopefully this document has given you an introduction to the project. Feel free to submit Pull Requests to improve this document.
Looking forward to your contributions! 🙌
To be discussed