Looking to contribute to DataGateway? Here's how you can help.
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
- Use the GitHub issue search -- check if the issue has already been reported.
- Check if the issue has been fixed -- try to reproduce it with the latest code
- Isolate the problem -- ideally create a minimal example.
- Create an issue -- provide as much relevant detail as possible.
A good bug report should contain all the information necessary to allow a developer to reproduce the issue, without needing to ask for further information.
Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue?
All of these details assist the process of investigating and fixing bugs.
Feature requests are welcome. Please provide as much detail and context as possible.
Create an issue to describe the feature.
Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.