We value your contributions and suggestions! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
We use GitHub issues to track public bugs. Report a bug by opening a new issue. Make sure the bug was not already reported by searching on GitHub under issues.
Write bug reports with detail, background, and sample code. Reports should include (not required):
- A quick summary and/or background
- Steps to reproduce
- Be specific
- Give sample code, HUDS XML example, and model example links if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from master.
- Prefix the branch with "feature/" for new features.
- Prefix the branch with "bugfix/" for bugfixes.
- Note if any extensions, references, packages, etc were added for your changes.
- If you've added code provide extensive details on what features were changed, added, or removed
- Ensure changes work as described.
- Issue that pull request!
We have not developed any standardized testing. Any help with this is greatly appreciated.
In short, when you submit code changes, your submissions are understood to be under the same Apache License 2.0 that covers the project. Feel free to contact the maintainers if that's a concern.
By contributing, you agree that your contributions will be licensed under its Apache License 2.0.