Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 2.57 KB
Raw

Contributing to WBC

Please inform the maintainer as early as possible about your planned feature developments, extensions, or bugfixes that you are working on. An easy way is to open an issue or a pull request in which you explain what you are trying to do.

Pull Requests

The preferred way to contribute to WBC is to fork the main repository on Gitlab, then submit a "pull request" (PR):

  1. Fork the project repository: click on the 'Fork' button near the top of the page. This creates a copy of the code under your account on the Gitlab server.

  2. Clone this copy to your local disk:

     $ git clone [email protected]:YourLogin/wbc.git

  3. Create a branch to hold your changes:

     $ git checkout -b my-feature

    and start making changes. Never work in the master branch!

  4. Work on this copy, on your computer, using Git to do the version control. When you're done editing, do::

     $ git add modified_files
 $ git commit

    to record your changes in Git, then push them to Gitlab with::

    $ git push -u origin my-feature

Finally, go to the web page of the your fork of the repo, and click 'Pull request' to send your changes to the maintainers for review.

Merge Policy

Summary: maintainer can push minor changes directly, pull request + 1 reviewer for everything else.

  • Usually it is not possible to push directly to the master branch of WBC for anyone. Only tiny changes, urgent bugfixes, and maintenance commits can be pushed directly to the master branch by the maintainer without a review. "Tiny" means backwards compatibility is mandatory and all tests must succeed. No new feature must be added.

  • Developers have to submit pull requests. Those will be reviewed by at least one other developer and merged by the maintainer. New features must be documented and tested. Breaking changes must be discussed and announced in advance with deprecation warnings.

  • Any change of existing functionality requires that all unit tests must succeed. In addition, the tutorials should be executed and the results should be compared with the results obtained prior to making those changes. If the results differ, the changes should be reconsidered.

  • Adding new functionality requires the addition of unit tests. In pinciple, every class should be accompanied by at least one unit test that checks the common use case, and one unit tests that checks for the common error cases

Project Roadmap

Check the Issue Tracker for roadmap planning.