Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

26 lines (17 loc) · 2.42 KB
Raw

Contributing

First of all, thanks for your interest in contribuiting to the makair project! Your Help is very appreciated here.

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.

How to make a Contribution?

To make a contribution, we recommend that you first first try building and installing the project on your machine, then look at our Issues to see if there is any request changes that you could already make (You can suggest changes also!). Then, when you are ready to change code, you must submmit a Pull Request, for that you can do the following steps:

  1. Make a fork from this repository, you can do this by clicking the "fork" button above (it is close to the star button! Make sure to hit that one too :D)
  2. Clone the fork repository into your machine, you can do that by doing git clone
  3. Make a new branch with a name that signifies your change, you can do that with git checkout -b 'branch-name'
  4. Make the commits into this new branch with the changes you want to make. Add changed files with git add filename and commit with git commit
  5. Then Push your changes into your branch, you can do that with git push origin branch-name
  6. Go to the Pull Request page and you should have a Pull Request button to open your Pull Request!

Once your change it is submitted, it will be revised by one of our maintainers and if approved the merge can be made by one of the owners. Changes may be requested, in which case you can do by making more commits to your branch or rebasing it, depending on the changes requested.

Pull Request Process

  1. Make sure you've read the README and understood the basics of the project.
  2. Check if there is no active Pull Request or Issue on the change or suggestion you are making. If that is the case, make sure to reference your change there.
  3. After you submit your pull request, make sure to tag the people that discussed the changes with you.