Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

30 lines (26 loc) · 3.59 KB
Raw

Getting started

  • If you are completely new to Flutter, you might first want to install the Flutter sdk. Please follow the official documentation for windows, Mac or Linux
  • If you are new to git or Github, please check out this repository
  • If you want some resources to learn Flutter, you might want to check this out.
  • IMP: To get Google-Sign in working properly on your deivice, please post the SHA-1 key on the slack channel, so that we can add it to the Firebase project. you can get your SHA-1 key through Android Studio or through the command line
  • Fork the repository.
  • Select an issue to work on. If you are contributing for the first time, issues tagged good-first-issue might be a great place to get started.
  • Create a Pull Request after solving the issue.

Working on issues

  • Please don't start working on an issue unless it is assigned to you. If you want to work on a specific issue that is currently not assigned to anyone, you can simply comment on the issue and one of the maintainers will assign the issue to you.
  • Issues are labeled with various tags which might help you in finding issues best-suited for you. The labels convey information regarding the difficulty of the issue, the estimated time required to solve the issue, and other relevent information.
  • You can find a list of all the tags and their meanings at the end of this document.

Creating an issue

  • Before creating an issue, make sure that a similar issue does not exist already.
  • Issues that you create could be related to anything from a bug in the codebase to the proposal for an entire feature.
  • Make sure to add appropriate labels to the issue so that it would be easier for everyone to get a gist of what the issue is.
  • By default, a new issue is assigned to the person who created the issue. However, if you are not interested in working on an issue you created, let us know in the comments and we will assign it to someone else.
  • For issues that describe a new feature to be introduced, please try to elaborate on why the feature might be useful and how we can go about implementing it. If you are unsure, the slack channel might be a great place to discuss.

Join the conversation

If you have any doubts specific to the codebase or have anything to discuss about the project, you can join the #radar_dev channel on the slack workspace.

List of issue labels and their meanings

  • good-first-issue: This means that it is a very simple issue and is good for new contributors who would like to get a basic understanding of the codebase.
  • bug: This indicates that the issue relates to a bug in the codebase.
  • enhancement: This indicates that the issue relates to an optimization or an improvement in the present codebase.
  • feature-request: Issues with this label give an overview of a new feature that is proposed.
  • difficulty labels: These are labels which indicate the level of understanding one requires to solve the issue. There are 4 different categories: mainly easy, medium, hard, and advanced. The difficulty level also roughly corrosponds to the amount of time one might need to devote to solve the issue.