Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

54 lines (35 loc) · 2.25 KB

Contributing to volmdlr

First off, thanks for taking the time to contribute!

All types of contributions are encouraged and valued. The community looks forward to your contributions.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Use volmdlr in your projects!
  • Star the project
  • Talk about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

I want to contribute to the code

Ask before coding

If you are not sure about your contribution you can ask the question on the issues or MP the project leader.

Process

We have a process based on three branches:

  • dev that receive the features and impacting changes pull requests
  • testing that is regularly a freeze of testing. Release candidate (RC) can be made on testing
  • master that receive the code from testing before the release. Release are made on master

Before coding, think of where to start from. You should start your branch for pull request where the pull request will point at:

  • if your contribution is trivial or has low risk of negative impact, start from master branch: simple and urgent bug fixes, docs, build...
  • in most other case, start from dev and submit your pull request to dev

CI

Your contribution may be refused by our CI. In this case:

  • lowering the coverage: add some tests
  • introducing pylint errors
  • triggering pydocstyle errors
  • non-respect of PEP8
  • no CHANGELOG.md edit

Correct the CI errors to get approval from volmdlr team!

I Have a Question

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions , depending on what seems relevant.
  • Put the label "Question" to your issue