Contributing to Ullr

Contributions to Ullr are welcome and encouraged! The backbone of the project is written in Python, but there is a fair amount of HTML, JavaScript, and CSS required by the web interface.

Not a coder? This documentation could use some work! Adding detail and clarity, or explaining a unique use case is much appreciated.

Ullr is Developed on Github

I use github to host code, to track issues and feature requests, as well as accept pull requests. See the Ullr GitHub homepage.

Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. Pull requests are actively welcomed!

  1. Fork the repo and create your branch from main.

  2. Make your changes.

  3. If your code changes how Ullr works, update the docs.

  4. Make sure your code lints (works).

  5. Issue that pull request!

Any contributions you make will be under the GNU GPL v3 license.

In short, when you submit code changes, your submissions are understood to be under the same GPL License that covers the project.

Report bugs using Github’s issues

Ullr uses GitHub issues to track public bugs. Report a bug by opening a new issue; it’s that easy!

References

This document was adapted from the open-source contribution guidelines for Facebook’s Draft