Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

33 lines (17 loc) · 2.37 KB

How to contribute

Thank you for considering contributing to dcor! You can contribute to dcor in several ways.

Opening issues

Open a new issue if you find some bug or you want to propose a new feature. Please first check that nobody has asked that already!

Make sure that your proposal is clearly written, preferably in English. In case you are reporting a bug, please include all relevant information, such as the software version and machine information.

Discussing the project

You can open a discussion for any topic related with this package. Do you have doubts about how to use the package? Open a discussion! Do you want to show related projects, recent research or some use case for this software? Open a discussion!

You are also encouraged to answer the discussions of other users and participate actively in the discussions forum.

Improving the documentation

Do you feel that the documentation could be more clear? Did you found a typo? You can easily edit the documentation and make a pull request clicking the "Edit this page" link in the documentation.

Advanced users can also propose the addition of new pages and examples. In case you want to do that, please open an issue to discuss that first.

Contributing software

You can improve this package by adding new functionality, such as new E-statistics and related tests. You can also try to solve pending bugs or accepted feature requests. In case that the contribution requires substantial effort, please discuss that first to ensure that it will be accepted and to assign that to you and prevent duplicated efforts.

In any case, make sure that you own the rights to the software and are ok with releasing it under a MIT license.

On the use of Generative AI

You may use generative AI to understand, search, debug or obtain suggestions about the project. However, please do not attempt to include any generative AI output directly in the submission. AI output lacks copyright, and thus it cannot be covered by the license of this project. Moreover, it is rude to make other people review something that you did not bother to write, and wastes resources that could be dedicated to reviewing PRs of people who did care enough to write by themselves. As a corollary, pull requests created automatically by generative AI will be closed without discussion.

You should disclose any use of generative AI in the pull request description.