Skip to content

Latest commit

 

History

History
executable file
·
74 lines (49 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
74 lines (49 loc) · 3.38 KB
Raw

Contributing to Ureport-Online

There are plenty of ways you can help if you are interested in contributing to the "Ureport Online Application"

Thank you for helping us make this project great and being a part of the "Ureport Online" community. Here are a few guidelines that will help you along the way.

Code of Conduct

IOGT-PWA has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.

What you need to know

In order to contribute as a developer you will need to have a basic understanding of:

  1. Dart
  2. Flutter
  3. Rapidepro messaging flow
  4. Firebase Cloud Messaging
  5. Firebase Push Notification
  6. FCM Channel

Issue tracking

uses GitHub’s tracker called Issues for easy collaboration among developers to keep track of tasks, enhancements, and bugs during software sprints. A typical issue looks like this:

  • A title and description describe what the issue is all about.
  • Color-coded labels help you categorize and filter your issues (just like labels in email).
  • A milestone acts like a container for issues. This is useful for associating a group of issues with specific features or time period (e.g. Weekly Sprint 9/7-7/20 or PWA 1.0).
  • One assignee is responsible for working on the issue at any given time.
  • Comments allow anyone with access to the repository to provide feedback.

Setting up your development environment

This is a starting point for new developers who wish to setup their development workstations. You can follow the steps are given below

  1. Clone the repo with 'git clone https://github.com/riseup-labs/ureport-online.git'
  2. Add your google-services.json file
  3. Run 'Flutter clean'
  4. Run 'Flutter pub get'
  5. Run 'Flutter run'

Coding style

Please follow the coding style of the project. is built in MVVM architecture

Submitting a Pull Request(Guidelines)

Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

In summary, if you want to contribute to :

  1. Claim an issue from the issue tracker.
  2. Fork the U-Report Online project.
  3. Clone it to your local system.
  4. Make a new branch.
  5. Make your changes.
  6. Try as much as you can to include unit tests for your changes.
  7. Push it back to your repo.
  8. Click the Compare & pull request button.
  9. Click Create pull request to open a new pull request.

CI/CD

We use Github Actions for continuous integration to automatically run unit tests while Heroku does the hosting of the releases for continous delivery.

Project Wiki

This documentation has several pages of information for developers, and people contributing to . Check it out for your authoritative source of information about the IOGT-PWA community.

License

By contributing your code to the unicefecar/ GitHub repository, you agree to license your contribution under the GNU Affero General Public License.