Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 1.75 KB
Raw

Contributing to PyDGN

Thanks for taking the time to contribute! ❤️

Report a Bug

You can report a bug by:

  • Going to the Issues section
  • Opening a new issue and select the Bug option
  • Fill in the text blocks that appear. Be as detailed as possible in the description of the bug, and (if possible, but highly appreciated) provide a script to reproduce your error.
  • Submit the issue =)

Request a new PyDGN feature

You can request a new feature by:

  • Going to the Issues section
  • Opening a new issue and select the Feature Request option
  • Be as detailed as possible in the description of the feature request, trying to suggest how we should implement it if you already have an idea.

Please remember that our goal is not to add new models or datasets to the library, rather to extend it to be as flexible as possible, so that we can use it for a larger number of research scenarios.

Add new code to PyDGN

If you want to contribute to the development of PyDGN, please feel free to open a pull request describing:

  • what is the reason for the changes / new feature - why you think it is useful
  • how well is your code documented (we'd like to keep 100% documentation percentage)
  • which tests you have implemented to check the correct functioning of your code
  • a simple example using the new feature (you can store data/model configurations in the examples folder)

Seeking Support

If you need support to use the library, please open a blank issue and describe your needs. We will do our best to assist you as quick as possible. Also, if possible please let's avoid emails so that everyone can benefit from the discussion.