Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 1.45 KB
Raw

Contributing

Thank you for contributing to this repository.

When contributing, 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.

How to contribute.

The general process to contribute to an open source project can be found in detail in this great post: https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/.

In summary, the process consists on 7 steps:

  1. Fork the repository to your GitHub account and clone it to your computer.
$ git clone https://github.com/USERNAME/FORK.git
  1. Create a upstream remote (to this repository) and sync your local copy.
$ git remote add upstream https://github.com/MuSAELab/amplitude-modulation-analysis-toolbox.git

At this point origin refers to your forked repository (in your account) and upstream to the repository in https://github.com/MuSAELab

$ git checkout master    
$ git pull upstream master && git push origin master
  1. Create a branch in your local copy.
git checkout -b fixing-something

  1. Perform the change, write good commit messages.

  2. Push your branch to your fork in GitHub.

git push -u origin fixing-something

  1. Create a new Pull Request.

  2. Feedback and to merge your work to the upstream repository