Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 2.98 KB
Raw

Contributing to Talawa

Thank you for your interest in contributing to Talawa. Regardless of the size of the contribution you make, all contributions are welcome and are appreciated.

If you are new to contributing to open source, please read the Open Source Guides on How to Contribute to Open Source.

Ways to Contribute

If you are ready to start contributing code right away, we have a list of good first issues that contain issues with a limited scope.

Our Development Process

We utilize GitHub issues and pull requests to keep track of issues and contributions from the community.

Issues

Feel free to open an issue if you spot any bugs or improvements you see in Talawa. Once an issue has been created, it will be triaged by the members of the Palisadoes Foundation. If passed, the issue will be open for assignment.

As you work through these issues, you will start to get a better understanding of the type of problems that get reported. You may even start noticing the same issue gets reported. In these cases, you can close the issue and add a comment that says “Duplicate of #issue”.

Pull Requests

Every pull request should be linked to an existing issue. A pull request should consist of a summary, to help us understand the motivation behind the changes.

Git Flow

For Talawa, we utilize the GitFlow branching model. GitFlow is geared towards efficiently tracking development and managing releases. The model makes parallel development efforts easy and safe by isolating new development efforts from completed work.

The different types of branches we may use are:

  • Feature branches (feature/branch-name)
  • Release branches (release/1.XX)
  • Bug branches (bugfix/branch-name)
  • Hotfix branches (hotfix/branch-name)

Detailed document containing how GitFlow works: https://nvie.com/posts/a-successful-git-branching-model/

Contributing Code

Code contributions to Talawa come in the form of pull requests. These are done by forking the repo and making changes locally.

The process of proposing a change to Talawa can be summarized as:

  1. Fork the Talawa repository and branch off master
  2. Make the desired changes to the Talawa source
  3. Run the app and test your changes
  4. If you've added code that should be tested, write tests
  5. Ensure the test suite passes, either locally or on CI once a PR has been created
  6. Push the changes to your fork
  7. Create a pull request to the Talawa repository
  8. Review and address comments on your pull request if requested

GSoC

If you are participating in the 2021 Summer of Code, please read more about us and our processes here

Community

The Palisadoes Foundation has a Slack channel where members can assist with support and clarification. Click here to join our slack channel.