CONTRIBUTING.md

July 10, 2019 ยท View on GitHub

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Getting Started

We use gitflow so instead of a single master branch, we use two branches to record the history of the project. The master branch stores the official release history, and the develop branch serves as an integration branch for features. It's also convenient to tag all commits in the master branch with a version number.

Workflow

If you would like to contribute to this project, please:

  • Pick an issue to work on or create a proposal for a new feature.
  • Fork this project.
  • Create your feature branch based off the develop branch.
  • Create a pull request to get your worked reviewed and merged back into the upstream develop branch.

Please include screenshots of your app changes and write down the test scenarios you followed to verify that your code works.

Feature proposals

Please create an issue, label it as a feature proposal and follow the following template:

# Proposal: [your title here]

## Summary
{Also include any designs or wireframes here}

## Rationale
{First reason for why we should consider this proposal}
{Second reason for why we should consider this proposal}
{etc}

## Scope

## Important Notes

## Open Questions

How to get unstuck

We have an active Slack community that you can reach out to for more information or just to chat with anyone. Check out the Slack Channel SED Android app development slack channel.

Also checkout the Open Source Guide.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Community Guidelines

  • Be considerate, kind, constructive, and helpful.
  • Do not engage in demeaning, discriminatory, harassing, or hateful speech, and imagery.