Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/reflectivity/slddb/issues.
If you are reporting a bug, please include:
- Is it a bug on the website or the slddb python package?
- Detailed steps to reproduce the bug.
Alternatively, you can send an email to slddb@esss.dk .
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
slddb is a tool for scientific use and thus aims to be as correct as possible. Checking of the uses calculations and elemnt data is very welcome. If you would like to contribute by verifying database entries, feel free to contract ORSO members to add you to the website as member.
The best way to send feedback is to file an issue at https://github.com/reflectivity/orsopy/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.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
- For website features any reference to scientific papers or sketch drawings of interfaces are very helpful.
Checkout the GitHub information on how to create forks and pull-requests.
Before you submit a pull request, check that it meets these guidelines:
- For core functionality it will be helpful to include new test cases.
- Make sure to test the website locally, first.