Contributing
Each GitHub repository contains important files in their topmost, or root, directories that you should know about. These include:
File | Purpose |
---|---|
README.md | The README.md file contains a summary of project's purpose. It includes links to other important files in the repository that you should read before starting |
CODE_OF_CONDUCT.md | This file contains guidelines of how each contributor in the community should behave and communicate with each other. It also states the consequences of going against these rules. By doing this we aim to provide a harassment-free environment and also an inclusive, healthy and diverse community. |
CONTRIBUTING.md | Everything you need to know to start contributing to our projects can be found here. It also includes ways to communicate with the community. |
DOCUMENTATION.md | This file points out some useful tips on where to find our documentation and how to use Docusaurus. |
INSTALLATION.md | The installation guide for the project. It will tell you step by step what you need to do to get the software running. This includes the dependencies to install, the required versions of supporting software and the necessary tips to get things working on your operating system. |
CONFIGURATION.md | Some repositories have this file to specify the configurations necessary to enable various features to make Talawa run smoothly. |
ISSUE_GUIDELINES.md | If you find a bug or feel a new feature is necessary, then open an issue. Don't ask for permission to create one, we need your contributions! However, if you want to do the work yourself, don't start before being assigned the task as we only accept Pull Requests (PRs) from people who have been assigned the corresponding issue. |
PR_GUIDELINES.md | When you are ready submit new code this document will explain what we need in your Pull Request (PR). We take this guide seriously as it tells you how to make sure your code will meet our standards and be accepted. |
Reading these files will help to make you contribute to Talawa even faster. We know you can't wait!