Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

57 lines (37 loc) · 2.85 KB
Raw

Introduction

First off, thank you for considering contributing to Dispa-SET.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Keep an open mind! Improving documentation, bug triaging, or writing tutorials are all examples of helpful contributions that mean less work for you.

Dispa-SET is an open source project and we love to receive contributions from our community. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code. Any of the following code contributions are welcome:

  • a new model feature
  • a programming improvement
  • a more elegant data handling method
  • or just a missing data point.

Ground Rules

  • Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Don't add any classes to the codebase unless absolutely needed. Err on the side of using functions.
  • Keep pull requests as small as possible, preferably one new feature per request.

Your First Contribution

Unsure where to begin contributing to DispaSET ? You can start by looking through these beginner and help-wanted issues or by contacting the main developers.

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub. Other sources to check: http://makeapullrequest.com/ and http://www.firsttimersonly.com/

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.

Getting started

For something that is bigger than a one or two line fix:

  1. Create your own fork of the code
  2. Do the changes in a branch of your fork
  3. If you like the change and think the project could use it:
    • Be sure you have followed the code style for the project.
    • Make sure that the code quality is of high standards
    • Make sure that the unit tests pass
    • Update the relevant parts of the documentation
    • Send a pull request.

How to report a bug

When filing an issue related to a bug, make sure to answer these five questions:

  1. What version are you using?
  2. What operating system and processor architecture are you using?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?