3.2 KiB
Contributing
Thank you for your interest in helping out the FabAccess system!
You found a bug, an exploit or a feature that doesn't work like it's documented? Please tell us about it, see Issues
You have a feature request? Great, check out the paragraph on Feature Requests
Issues
While we try to not have any bugs or exploits or documentation bugs we're not perfect either. Thanks for helping us out!
We have labels that help us sort issues better, so if you know what would be the correct ones, please tag your issue with one or multiple keywords. See Labels to get an overview of all keywords and their use case.
Especially for bugs and exploits, please mark your issue as "confidential" if you think it impacts the stable branch. If you're not sure, mark it as confidential anyway. It's easier to publish information than it is to un-publish information. You may also contact as by mail.
Feature Requests
We also like new feature requests of course! But before you open an issue in this repo for a feature request, please first check a few things:
- Is it a feature that needs to be implemented in more than just the backend server? For example, is it something also having a GUI-component or something that you want to be able to do via the API? If so it's better suited over at the Lastenheft because that's where the required coordination for that will end up happening
- Who else needs that feature? Is this something super specific to your environment/application or something that others will want too? If it's something that's relevant for more people please also tell us that in the feature request.
- Can you already get partway or all the way there using what's there already? If so please also tell us what you're currently doing and what doesn't work or why you dislike your current solution.
Contributing Code
To help develop Difluoroborane you will need a Rust toolchain. We heavily recommend installing rustup even if your distribution provides a recent enough rustc, simply because it allows to easily switch compilers between several versions of both stable and nightly. It also allows you to download the respective stdlib crate, giving you the option of an offline reference.
We use a stable release branch / moving development workflow. This means that all new development should happen on the development branch which is regularly merged into stable as releases. The exception of course are bug- and hotfixes that can target whichever branch.
If you want to add a new feature please work off the development branch. We suggest you create yourself a feature branch, e.g. using
git switch development; git checkout -b feature/my-cool-feature
Using a feature branch keeps your local development branch clean, making it easier to later rebase your feature branch onto it before you open a pull/merge request.
When you want feedback on your current progress or are ready to have it merged upstream open a merge request. Don't worry, we don't bite! ^^