Skip to content

Latest commit

 

History

History
104 lines (61 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

104 lines (61 loc) · 2.83 KB
Raw

Contributing

You can help the developers of Partitura by contributing, requesting features or reporting error.

Opening an Issue

To open an issue navigate to the partitura github repository:

Click to New Issue

Write your description

Choose the appropriate label

How to choose your issue label:
  • Question to ask us a question or help wanted if you need a solution to a particular partitura problem.
  • Bug to report something not working correctly.
  • Enhancement to request for a feature.

How to contribute

A step by step guide :

  1. To contribute is to open a relevant issue.
  2. Fork the Partitura repo.
  3. Checkout or Pull the latest stable develop branch.
  4. Checkout a new branch from the develop with the name of your develop idea.
  5. When finished coding, open a pull request to the develop branch of partitura.

Open a relevant issue

Follow section how to open an issue.

Fork the Repo

Fork partitura from https://github.com/CPJKU/partitura

Once that you have already forked the repo, you can clone it:

git clone https://github.com/YourUsername/partitura.git
cd partitura

Get latest Develop Branch

git fetch upstream
git checkout develop
git pull

Create your Branch

git checkout -b mycrazyidea

Do your coding magic!!!

Remember to commit regularly with descriptive messages about your changes.

!!! IMPORTANT NOTE !!!

Write Unit tests to check the compatibility and assure the evolution of your features.

Please follow instruction script found in the Tutorial repository.

Opening your Pull Request

Go to your forked Partitura repo and Click New Pull Request

Open a Pull request from your new branch into the original https://github.com/CPJKU/partitura develop branch.

Your pull request should then be visible on:

Set the base to develop and the compare to your branch

Then create your Pull Request and add a description.

When you create your PR then the partitura Unitests including the Unit Tests you wrote are ran.

If there is no conflict with the develop branch then you will see this on your screen :

If indeed the tests pass then a person from the development team of Partitura will review your work and accept your Pull Request.

Your features will then be included to the next release of Partitura or a discussion will kick-start on your pull request thread.