Skip to content

Latest commit

 

History

History
127 lines (90 loc) · 5.42 KB

CONTRIBUTING.md

File metadata and controls

127 lines (90 loc) · 5.42 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Coding Process

  1. Name your branch using the following format: {feature/patch/bugfix}/#{issue number}-{issue description}
  • Example: feature/#68-migration-to-null-safety
  1. Leave the code in a better state than before your changes. That does mean performing refactoring in the areas around the modified code.
  2. Test your changes using unit tests.
  3. Run flutter analyze before submitting a pull request and fix any discovered issues.

Versioning

The CI automatically updates the version in the pubspec.yaml file when opening a pull-request using the specified label: version: Major,version: Minor or version: Patch.

  • version: Major: used when a complete UI redesign is done or when a complete rewrite is done in the project;
  • version: Minor: used when adding a feature in the application;
  • version: Patch: used when no feature was added to the project. This includes refactoring, patches, bug fixes, etc.

Pull Request Process

  1. Define a related Issue

If suggesting a new feature or change, please discuss it in an issue first For more explanation: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword Please link the issue here: (use keyword closes: #12345)

  1. Description

Describe your changes in details.

  1. Has This Been Tested?

Please describe how you tested your changes. Include details of your unit test, and the manual tests you did see how your change affects other areas of the code, etc.

  1. Checklist before requesting a review

Make sure to fill out the following checklist for a change request:

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.
  • Do we need to implement analytics?
  • Make sure to add either one of the following labels: version: Major,version: Minor or version: Patch.
  1. Screenshots (if useful)

If it's a visual change, please provide a screenshot.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4