Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 4.23 KB

Contributing guidelines

Welcome to EEGraph! First of all, thank you for taking the time to contribute and make this project better! Make sure that you read the whole Contribution guidelines before sending your pull requests.

Contribution to this repository

You can contribute to EEGraph in many ways:

  • Suggesting a feature.
  • Filing a bug report.
  • Improving the documentation.
  • Improving comments.
  • Writing proper tests.
  • Submitting a pull request.

📜 Licensing

When you sumbit your code to EEGraph, you implicitly agree to adopt the associated licenses. Your work will be distributed under GPL-3.0 License once your pull request is merged.

💡 Suggesting a feature

If you have a good idea for a feature please let us know! From improvements for already existing functionalities to completely new features.

Make sure to:

  • Check if there is a newer version which already provides this feature.
  • Check if the feature has already been suggested in the issues (Open or closed) section. If it exists, please add a comment to the existing issue instead of opening a new one.
  • Use the enhancement issue label.
  • Consider if its necessary in the library.

🪲 Filing a bug report

If you find some sort of bug, problem or something that should be updated. Please first search the open issues to see if someone has already reported the issue.

If its something new, please file a bug report on the repository issue section to let us know. Be as detailed as posible, and be ready to give us some feedback if needed. Make sure to:

  • Tell us where is the problem. As detailed as possible.
  • Provide the usage example, so we can replicate the problem.
  • Use the bug issue label.
  • Be ready to provide feedback if needed.

📙 Improving documentation

The documentation for EEGraph can be founde here. Clear and complete documentation is key for users to understand the library and the code. Please dont hesitate to submit any feedback to improve it, recomendations, single-letter typos, errors, extensions. Anything that improves the documentation for all future users is welcomed.

Documentation related issues should be tagged with the documentation issue label.

🛠️ Submitting a pull request

All New implementations are welcome! New solutions for any problem. New frequency and time-frequency domain connectivity measures to modelate EEGs as graphs. Extensions of EEGraph current functionalities. Working on suggested features listed here. Fixing reported bugs listed here.

Please check wheter the solution is already implemented or not before sumbitting your pull request. If the change you want to introduce will require a significant amount of work to write, it is recommended to open an issue stating what you want to do. In this way you can have a conversation with other contributors that might help you have a better idea.

Make sure:

  • The file extension for code files shoud be .py.
  • Avoid using external libraries for basic algorithms.
  • If a new library is used that is not listed in the requirements, make sure to add it for your submission.
  • You should try to write tests that ensure the provided code works as expected.
  • Add or change the documentation as needed.
  • Make sure the pull request is done to the project´s develop branch.

🏆 Your PR is merged!

Congratulations! The EEGraph team and the whole Python community thanks you.

You will be listed as a contributor in the repository contributors.