-
Notifications
You must be signed in to change notification settings - Fork 8
4. Contributing
Contributions are very welcome. Please read our Contribution Guidelines to know how to proceed.
Contributions are welcome and appreciated, however before submiting a pull request make sure to read this document and that the pull request follows all of the guidelines.
We also reserve the right to not accept contributions that add no meaningful changes or go out of the scope of the project.
Report bugs at https://github.com/HenriquesLab/NanoPyx/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
The best way to send feedback is to file an issue at https://github.com/HenriquesLab/NanoPyx/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
Ready to contribute? Here's how to set up nanopyx for local development.
-
Fork the nanopyx repo on GitHub.
-
Clone your fork locally::
$ git clone [email protected]:your_name_here/nanopyx.git -
Follow the installation instructions in the readme to install a nanopyx environment.
-
Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-featureNow you can make your changes locally.
-
When you're done making changes, check that your changes pass our tests::
$ pytestMake sure you have installed the optional nanopyx testing dependencies.
-
Commit your changes and push your branch to GitHub::
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature -
Submit a pull request through the GitHub website.
Before you submit a pull request, check that it meets these guidelines:
- The pull request should pass every existing test.
- The pull request should work for Python 3.8, 3.9 and 3.10
- If the pull request adds functionality, new automated tests should be included in the pull request covering the new functionality
- Please ensure pytest coverage at least stays the same before you submit a pull request.
- The core development team reserves the right to reject pull requests, particularly if these only entail cosmetic changes to the code such as orthographic correction or the addition of type hint to variables.
Tutorial coming soon!
For now, you can look at the example files named:
- src/nanopyx/liquid/_le_template_simple.pyx
- src/nanopyx/liquid/_le_template_advanced.pyx
- src/include/_c_template_advanced.c
- src/include/_c_template_advanced.h
The default way to recognise contributions is via the contributors section of the repository. The attribution of authorship to future publications derived from the NanoPyx project are not given "automatically" to contributors and follow the guidelines:
- Authorship roles and expectations are discussed early on in the project and ultimately decided by the senior project lead (Ricardo Henriques). This is often an ongoing conversation throughout the project, as roles and contributions may change over time.
- All authors are expected to contribute significantly to the project. This includes conception, design, development of functionality, data acquisition, analysis and interpretation, and drafting and revising the manuscripts. These contributions are done with prior discussion and agreement of the senior project lead and core development team.
Please note that this project is follows a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
If you have questions, feel free to ask via GitHub issues. For general inquiries, please contact the project senior project lead Ricardo Henriques.
Thank you for contributing to nanopyx! We appreciate your time and effort in making this project better.