mirror of
https://gitlab.com/fabinfra/fabaccess/bffh.git
synced 2024-11-10 17:43:23 +01:00
Update CONTRIBUTING.md
This commit is contained in:
parent
16c94ae473
commit
000ffbc2dc
@ -2,15 +2,53 @@
|
|||||||
|
|
||||||
Thank you for your interest in helping out the FabAccess system!
|
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](#issues)
|
||||||
|
|
||||||
|
You have a feature request? Great, check out the paragraph on [Feature Requests](#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:
|
||||||
|
- `documentation` if it's an documentation issue, be it lacking docs or even worse wrong docs.
|
||||||
|
- `bug` is for software bugs, unexpected behaviour, crashes and so on.
|
||||||
|
- `exploit` for any bugs that may be used as RCE, to escalate priviledges or some-such.
|
||||||
|
Don't worry if you aren't sure about the correct labels, an issue opened with no labels is much
|
||||||
|
better than no knowing about the issue!
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
If you found an exploit and it's high-impact enough that you do not want to open an issue but
|
||||||
|
instead want direct contact with the developers, you can find public keys respectively fingerprints
|
||||||
|
for GPG, XMPP+OMEMO and Matrix+MegOlm in the git repository as blobs with tags assigned to them.
|
||||||
|
|
||||||
|
You can import the gpg key for dequbed either from the repository like so:
|
||||||
|
```
|
||||||
|
$ git cat-file -p keys/dequbed/gpg | gpg --import-key
|
||||||
|
```
|
||||||
|
Or from your local trusted gpg keyserver, and/or verify it using [keybase](https://keybase.io/dequbed)
|
||||||
|
This key is also used to sign the other tags so to verify them you can run e.g.
|
||||||
|
```
|
||||||
|
$ git tag -v keys/dequbed/xmpp+omemo
|
||||||
|
```
|
||||||
|
|
||||||
|
## Feature Requests
|
||||||
|
|
||||||
|
## Contributing Code
|
||||||
|
|
||||||
To help develop Diflouroborane you will need a Rust toolchain. I heavily recommend installing
|
To help develop Diflouroborane you will need a Rust toolchain. I heavily recommend installing
|
||||||
[rustup](https://rustup.rs) even if your distribution provides a recent enough rustc, simply because
|
[rustup](https://rustup.rs) 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
|
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.
|
allows you to download the respective stdlib crate, giving you the option of an offline reference.
|
||||||
|
|
||||||
## Git Workflow / Branching
|
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
|
||||||
We use a stable master / moving development workflow. This means that all /new/ development should
|
|
||||||
happen on the `development` branch which is regularly merged into `master` as releases. The
|
|
||||||
exception of course are bug- and hotfixes that can target whichever branch.
|
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
|
If you want to add a new feature please work off the development branch. We suggest you create
|
||||||
|
Loading…
Reference in New Issue
Block a user