Contribution guide¶
How to start?¶
You can contribute in multiples ways:
- Reporting an issue
- Requiring a new feature
- Testing the code and the software in different PC configurations and OS
- Improving the code
- Checking the documentation content
- Generating a new o improving the current BFE methods
- and much more...
To report issues, we have created a template that contains almost everything you need to identify the problem.
Step-by-step guide¶
Before reporting an issue, require for a new feature or make a question¶
Please ensure that you have read the following docs:
New feature¶
- Make an issue with your feature description;
- We shall discuss the design and its implementation details;
- Once we agree that the plan looks good, go ahead and implement it.
Bugfix¶
- Goto GitHub issues;
- Pick an issue and comment on the task that you want to work on this feature;
- If you need more context on a specific issue, please ask, and we will discuss the details.
Once you finish implementing a feature or bugfix, please send a Pull Request.
If you are not familiar with creating a Pull Request, here are some guides: - http://stackoverflow.com/questions/14680711/how-to-do-a-github-pull-request - https://help.github.com/articles/creating-a-pull-request/
Contribution best practices¶
Coming soon!
Github CI¶
Coming soon!
Documentation¶
xBFreE Project, xBFreE and xBFreE-Analyzer have their own documentations based in Mkdocs-Material. We additionally use external plugins and modified code to optimize the content.
For the code documetation, xBFreE uses Google style for formatting docstrings. Length of a line inside docstrings block must be limited to 100 characters to fit into Jupyter documentation popups.
If you have some issues with building docs - please make sure that you installed the required pip packages.
Tests¶
Coming soon!
Adding new tests¶
Coming soon!
Integrations¶
If you have contributed a new functionality with extra dependencies, please ensure you have submitted the required tests (Coming soon!).