Interested in contributing? That's awesome! Here are some guidelines to get started quickly and easily:
If you're about to raise an issue because you think you've found a problem with UAL Hypha, or you'd like to make a request for a new feature in the codebase, or any other reason… please read this first.
The GitHub issue tracker is the preferred channel for bug reports, feature requests, and submitting pull requests, but please respect the following restrictions:
-
Please search for existing issues. Help us keep duplicate issues to a minimum by checking to see if someone has already reported your problem or requested your idea.
-
Please be civil. Keep the discussion on topic and respect the opinions of others. See also our Contributor Code of Conduct.
A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
-
Use the GitHub issue search — check if the issue has already been reported.
-
Check if the issue has been fixed — look for closed issues in the current milestone or try to reproduce it using the latest
mainbranch.
A good bug report shouldn't leave others needing to chase you up for more information. Be sure to include the details of your environment and relevant tests that demonstrate the failure.
Feature requests are welcome. Before you submit one be sure to have:
- Use the GitHub search and check the feature hasn't already been requested.
- Take a moment to think about whether your idea fits with the scope and aims of the project.
- Remember, it's up to you to make a strong case to convince the project's leaders of the merits of this feature. Please provide as much detail and context as possible, this means explaining the use case and why it is likely to be common.
Change requests cover both architectural and functional changes to how UAL Hypha works. If you have an idea for a new or different dependency, a refactor, or an improvement to a feature, etc - please be sure to:
- Use the GitHub search and check someone else didn't get there first
- Take a moment to think about the best way to make a case for, and explain what you're thinking. Are you sure this shouldn't really be a bug report or a feature request? Is it really one idea or is it many? What's the context? What problem are you solving? Why is what you are suggesting better than what's already there?
Code contributions are welcome and encouraged! If you are looking for a good place to start, check out the good first issue label in GitHub issues.
Also, please follow these guidelines when submitting code:
To get it out of the way:
- develop is the development branch. All work on the next release happens here so you should generally branch off
develop. Do NOT use this branch for a production site. - master contains the latest release of UAL Hypha. This branch may be used in production. Do NOT use this branch to work on UAL Hypha's source.
Pull requests are awesome. If you're looking to raise a PR for something which doesn't have an open issue, please think carefully about raising an issue which your PR can close, especially if you're fixing a bug. This makes it more likely that there will be enough information available for your PR to be properly tested and merged.
Never underestimate just how useful quality assurance is. If you're looking to get involved with the code base and don't know where to start, checking out and testing a pull request is one of the most useful things you could do.
Essentially, check out the latest develop branch, take it for a spin, and if you find anything odd, please follow the bug report guidelines and let us know!