Skip to content

Latest commit

 

History

History
41 lines (22 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

41 lines (22 loc) · 2.01 KB

How to contribute to EvalNE

Did you find a bug?

  • Ensure the bug was not already reported by searching the GitHub repo under Issues.

  • If there is no open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

  • If possible, use our bug report template to create the issue.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the description clearly summarizes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

  • Ensure that there is no other request for said feature by searching the GitHub repo under Issues.

  • If there is no open issue addressing the problem, open a new one. Be sure to include a title and clear description of the requested feature. Also motivate why the feature is needed and that it fits the scope of EvalNE.

  • If possible, use our feature report template to create the issue.

Do you have questions about the source code?

Do you want to contribute to the documentation?

  • Improvements to the Docstring? to the Read The Docs page? to Code format?

  • Write us to our contact email describing the changes you propose.

Thanks!

EvalNE Team