Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 4.98 KB

CONTRIBUTING.md

File metadata and controls

82 lines (58 loc) · 4.98 KB

Contributing to this project

A big welcome and thank you for considering contributing to this open source project!

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.

Quicklinks

Code of Conduct

We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.

Getting Started

Contributions are made to this repo via Issues and Pull Requests. A few general guidelines that cover both:

  • Search for existing Issues and PRs before creating your own.
  • We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.

Issues

Issues should be used to report problems with this project, request a new feature, or to discuss potential changes before a PR is created. If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a reaction can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.

Pull Requests

PRs to this project are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:

  • Only fix/add the functionality in question OR address wide-spread whitespace/style issues, not both.
  • Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
  • Address a single concern in the least number of changed lines as possible.

For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.

In general, we follow the "fork-and-pull" Git workflow

  1. Fork this repository to your own Github account by clicking the Fork button.

  2. Clone your forked repository to your local machine

    For example, run this command inside your terminal:

    git clone https://github.com/<your-github-username>/calculator.git

    Replace <your-github-username> with your GitHub Username!

    Learn more about forking and cloning a repo.

  3. Create a development branch locally with a succinct but descriptive name

    git checkout -b master

  4. Add & commit changes to the branch with git add, git commit (write a good commit message, if possible):

    git add .
git commit -m "<your message>"

  5. Before you make any changes, keep your fork in sync to avoid merge conflicts:

    git remote add upstream https://github.com/<your-github-username>/calculator.git
git fetch upstream
git pull upstream master
git push

    Alternatively, GitHub also provides syncing now - click "Fetch upstream" at the top of your repo below "Code" button.

  6. Following any formatting and testing guidelines specific to this repo

  7. Push changes to your fork

    git push origin master

  8. Open a PR in our repository on the GitHub page of your fork, and make a pull request. Read more about pull requests on the GitHub help pages.

  • Now wait until your Pull Request merge! If there are any conflicts, you will get a notification.