Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

40 lines (23 loc) · 1.94 KB
Raw

Contributing

Thank you for considering contributing to mcQA 🙏

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.

Code of Conduct

This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

mcQA is an open source project and we love to receive contributions from our community! There are many ways to contribute: improving the documentation, reporting bugs, suggesting or proposing new features, sharing your results...

Your First Contribution

Unsure where to begin contributing to mcQA?

You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Working on your first Pull Request?

Here are some example steps to get it done:

  • Fork the project from master branch with the name of the issue you want to fix.
  • Commit to your fork until your fix is done.
  • Open a pull request in order to merge your fork with the master.
  • Discuss with peers and update your code until pull request is accepted by repository admins.
  • Synchonise your repository with the latest master changes.
  • Repeat!

See more about this workflow at https://guides.github.com/introduction/flow/

Trouble setting up your environment ?

You can use this docker image or use Google Colab.
Check out this example for starters.