Skip to content

Latest commit

 

History

History
87 lines (69 loc) · 5.17 KB

CONTRIBUTING.md

File metadata and controls

87 lines (69 loc) · 5.17 KB
Raw

Contributing to Calculator

The Calculator team encourages community feedback and contributions. Thank you for your interest in making Calculator better! There are several ways you can get involved.

Reporting issues and suggesting new features

If Calculator is not working properly, please file a report. Feedback Hub reports automatically include diagnostic data, such as the version of Calculator you're using.

We are happy to hear your ideas for the future of Calculator. Check the GitHub issues and see if others have submitted similar feedback. You can upvote existing feedback or submit a new suggestion.

We always look at upvoted items in Feedback Hub when we decide what to work on next. We read the comments in both Feedback Hub and GitHub, and we look forward to hearing your input. Remember that all community interactions must abide by the Code of Conduct.

Finding issues you can help with

Looking for something to work on? Issues marked good first issue are a good place to start.

You can also check the help wanted tag to find other issues to help with. If you're interested in working on a fix, leave a comment to let everyone know and to help avoid duplicated effort from others.

Contributions we accept

We welcome your contributions to the Calculator project, especially to fix bugs and to make improvements which address the top issues reported by Calculator users. Some general guidelines:

  • DO create one pull request per Issue, and ensure that the Issue is linked in the pull request.
  • DO follow our Coding and Style guidelines, and keep code changes as small as possible.
  • DO include corresponding tests whenever possible.
  • DO check for additional occurrences of the same problem in other parts of the codebase before submitting your PR.
  • DO link the issue you are addressing in the pull request.
  • DO write a good description for your pull request. More detail is better. Describe why the change is being made and why you have chosen a particular solution. Describe any manual testing you performed to validate your change.
  • DO NOT submit a PR unless it is linked to an Issue marked triage approved. This enables us to have a discussion on the idea before anyone invests time in an implementation.
  • DO NOT merge multiple changes into one PR unless they have the same root cause.
  • DO NOT submit pure formatting/typo changes to code that has not been modified otherwise.

We follow a user-centered process for developing features. New features need sponsorship from the Calculator team, but we welcome community contributions at many stages of the process.

Submitting a pull request for an approved Issue is not a guarantee it will be approved. The change must meet our high bar for code quality, architecture, and performance, as well as other requirements.

Making changes to the code

Preparing your development environment

To learn how to build the code and run tests, follow the instructions in the README.

Style guidelines

The code in this project uses several different coding styles, depending on the age and history of the code. Please attempt to match the style of surrounding code as much as possible.

Testing

Your change should include tests to verify new functionality wherever possible. Code should be structured so that it can be unit tested independently of the UI. Manual test cases should be used where automated testing is not feasible.

Git workflow

Calculator uses the GitHub flow where most development happens directly on the master branch. The master branch should always be in a healthy state which is ready for release.

If your change is complex, please clean up the branch history before submitting a pull request. You can use git rebase to group your changes into a small number of commits which we can review one at a time.

When completing a pull request, we will generally squash your changes into a single commit. Please let us know if your pull request needs to be merged as separate commits.

Review Process

After submitting a pull request, members of the calculator team will review your code. We will assign the request to an appropriate reviewer. Any member of the community may participate in the review, but at least one member of the Calculator team will ultimately approve the request.

Often, multiple iterations will be needed to responding to feedback from reviewers. Try looking at past pull requests to see what the experience might be like.