Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 2.39 KB

Contributing

Neurocaps is an open-source package, and all contributions are welcome to help improve, enhance, and refine it!

Since the repository for Neurocaps is located on GitHub, you will need to create an account. Here are some instructions to get you started.

Code of Conduct

Before making a contribution, please be aware of the code of conduct.

Labels

Below are the current list of labels that can be used when opening an issue:

Bug

  • These issues relate to unexpected behaviors. Please provide a detailed report of any bugs encountered so that it may be replicated and properly addressed.

Documentation

  • These issues relate to improvements or enhancements to documentation.

Enhancement

  • These issues relate to requested new features or improvements to existing ones.

Workflow for Making Changes

1. Open an issue or commit on an existing issue

To allow any changes to be tracked and ensure that any changes aren't being duplicated.

2. Fork neurocaps

This is your own unique copy of neurocaps and changes will not affect the main codebase. Here are some guides to forking and ensuring that your fork is always synced with the main codebase.

3. Submit a pull request

After implementing the changes discussed in the issue, submit a pull request so that the code can be reviewed before merging into the main codebase.

Receiving Credit

Please remember to add your credentials to the zenodo to receive proper recognition foy your contribution to neurocaps.

Thank you for your contribution!