📝 Add community governance docs

This commit is contained in:
Luke Vella 2023-03-24 09:31:40 +00:00
parent 243c9984cb
commit a148feac7f
3 changed files with 70 additions and 0 deletions

11
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,11 @@
## Description
**Replace me with a summary of the change and which issue is fixed. Please also include relevant motivation and context.**
## Checklist
Please check off all the following items with an "x" in the boxes before requesting a review.
- [ ] I have performed a self-review of my code
- [ ] My code follows the code style of this project
- [ ] I have commented my code, particularly in hard-to-understand areas

19
CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,19 @@
# Code of Conduct
We are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, religion, or any other personal characteristics.
We do not tolerate any form of harassment, discrimination, or disrespectful behavior towards others, whether it be in-person or online. This includes but is not limited to:
- Offensive comments related to gender, sexual orientation, ability, ethnicity, religion, or any other personal characteristics.
- Verbal or physical threats.
- Bullying or intimidation.
- Unwanted physical contact or attention.
- Stalking or following.
- Non-consensual photography or recording.
- Disruptive or inappropriate behavior.
If anyone engages in such behavior, they will be asked to stop immediately. Failure to comply with this request will result in removal from the repository or project.
If you are the target of any form of harassment or discrimination, or witness any such behavior, please contact [insert contact person or email address here] immediately. We take all reports seriously and will investigate them thoroughly.
We expect all contributors, including maintainers and moderators, to uphold this code of conduct in all project-related settings.

40
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,40 @@
# Contributing Guide
Contributions are welcome from anyone who is interested in improving this project and there are multiple ways in which you can contribute:
## Code
Have a look at the [open issues](https://github.com/lukevella/rallly/issues) and look for issues that are labeled with `help wanted` or `good first issue`. If you find an issue that you would like to work on, please leave a comment on the issue to let us know.
If there isn't an issue for the work that you would like to contribute, start by opening a [discussion](https://github.com/lukevella/rallly/discussions/new/choose) to discuss the changes that you would like to make.
In order to maintain a high standard of code quality, please ensure that you are familiar with the technology stack used in this project where it applies to your coode. The technology stack used in this project is:
- [TypeScript](https://www.typescriptlang.org/)
- [React](https://reactjs.org/)
- [Next.js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [tRPC](https://trpc.io/)
- [Prisma](https://www.prisma.io/)
## Translations
To contribute translations, please check out our [Guide for Translators](https://github.com/lukevella/rallly/wiki/Guide-for-translators) which contains all the information you need to get started.
## Becoming a Sponsor
If you find this project useful and would like to contribute financially on an ongoing basis, please consider becoming a sponsor. Sponsors help us cover the costs of hosting, development, and maintenance, and enable us to continue working on the project.
To become a sponsor, visit our [sponsor page](https://github.com/sponsors/lukevella) and select the sponsorship level that works for you.
Donations are also accepted through [PayPal](http://paypal.me/ralllyco).
## Code of Conduct
Please note that this project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
## License
By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](LICENSE) file.
Thank you for your interest in contributing to this project!