Skip to content

Latest commit

 

History

History
82 lines (51 loc) · 5.35 KB

CONTRIBUTING.md

File metadata and controls

82 lines (51 loc) · 5.35 KB
Raw

Contributing to MDDC

This CONTRIBUTING.md is adapted from Peter Desmet's guide.

First of all, thanks for considering contributing to MDDC!

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How You Can Contribute

There are several ways you can contribute to this project.

Share the Love ❤️

Think MDDC is useful? Let others discover it, by telling them in person, via Twitter, ResearchGate, or a blog post.

Using MDDC for a paper you are writing? Consider citing it.

Ask a Question ⁉️

Using MDDC and got stuck? Browse the documentation to see if you can find a solution. Still stuck? Post your question as an issue on GitHub. While we cannot offer user support, we'll try to do our best to address it, as questions often lead to better documentation or the discovery of bugs.

Want to ask a question in private? Contact the package maintainer by mail.

Propose an Idea 💡

Have an idea for a new MDDC feature? Take a look at the documentation and issue list to see if it isn't included or suggested yet. If not, suggest your idea as an issue on GitHub. While we can't promise to implement your idea, it helps to:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible.

See below if you want to contribute code for your idea as well.

Report a Bug 🐛

Using MDDC and discovered a bug? That's annoying! Don't let others have the same experience and report it as an issue on GitHub so we can fix it. A good bug report makes it easier for us to do so, please try to give as much detail as possible at Bug Report.

Improve the Documentation 📖

Noticed a typo on the website? Think a function could use a better example? Good documentation makes all the difference, so your help to improve it is very welcome! Submit an issue here Documentation Improvement.

API Documentation

The API documentation is built automatically from the docstrings of classes, functions, etc. in the source files. The docs are built with devtools::build_manual().

  • Go to the R/ or src/ directory in the code repository.
  • Look for the file with the name of the function.
  • Propose a file change to update the function documentation in the Roxygen comments (starting with #').

Contribute Code 📝

Care to fix bugs or implement new functionality for MDDC? Awesome! 👏 Have a look at the issue list and leave a comment on the things you want to work on. See also the development guidelines below.

Development Guidelines

We try to follow the GitHub flow for development.

  1. Fork this repo and clone it to your computer. To learn more about this process, see this guide.
  2. If you have forked and cloned the project before and it has been a while since you worked on it, pull changes from the original repo to your clone by using git pull upstream master.
  3. Open the folder on your local machine using any code editor.
  4. Make your changes:
    • Write your code.
    • Test your code (bonus points for adding unit tests).
    • Document your code (see function documentation above).
    • Check your code with pytest.
  5. Commit and push your changes.
  6. Submit a pull request.

Future Developments

Regular updates and bug fixes are planned to continually enhance the package's functionality and user experience. One of our primary goals is to make MDDC increasingly user-friendly, with improvements to the user experience and the layout of the outputs. User feedback is highly valued and will be a key driver of future development. This Life Cycle Statement is subject to periodic review and will be updated to reflect the evolving nature of MDDC.