luckyimnotanigger/Aegis
1
0
Fork 0
mirror of https://github.com/beemdevelopment/Aegis.git synced 2025-06-05 06:10:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Update contributing guidelines

Browse source 
This adds a blurb about translations to CONTRIBUTING.md and rewords some
sentences there. I also added a Contributing section to the README.
This commit is contained in:
Alexander Bakker 2020-08-05 16:40:20 +02:00
parent e5d162be9b
commit 0368a992de
2 changed files with 35 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

37
CONTRIBUTING.md
View file

@ -1,25 +1,40 @@
# Contributing # Contributing
There are a couple of ways to contribute to Aegis. This document contains some Looking to contribute to Aegis? That's great! There are a couple of ways to help
general guidelines for each type of contribution. out. This document contains some general guidelines for each type of
contribution.
## Translations
We use [Crowdin](https://crowdin.com/project/aegis-authenticator) to crowdsource
translations of Aegis for lots of different languages. __Pull requests that
add/update a translation are not longer accepted.__ Crowdin is our single source
of truth for translations, to keep things easy to maintain.
The top 30 languages are available for translation. It's possible that yours is
not in that list. If that's the case, feel free to send us an email and we'll
add it.
## Pull requests ## Pull requests
If you're planning on adding a new feature or making other large changes, please If you're planning on adding a new feature or making other large changes, please
discuss it with us first through a proposal on GitHub. Discussing your idea with discuss it with us first through [a
us first ensures that everyone is on the same page before you start working on proposal](https://github.com/beemdevelopment/Aegis/issues/new?labels=proposal&template=feature.md)
your change. We don't like rejecting pull requests. on GitHub. Discussing your idea with us first ensures that everyone is on the
same page before you start working on your change. We don't like rejecting pull
requests.
## Bug reports ## Bug reports
We use GitHub's issue tracker to track bugs. Bug reports must follow [the We use GitHub's issue tracker to track bugs. To make bug reports easier to
follow up on for us, they must follow [the
template](.github/ISSUE_TEMPLATE/bug.md). If a bug report does not follow the template](.github/ISSUE_TEMPLATE/bug.md). If a bug report does not follow the
template and does not contain enough information, it will be closed without a template and does not contain enough information, it will be closed. Duplicate
response. Duplicate bug reports receive the same treatment. bug reports receive the same treatment.
Please consider trying to find the root cause yourself first and perhaps even Please consider trying to find the root cause yourself first and include your
send us a patch that fixes the issue! We're happy to help you if you get stuck analysis of the issue in your report. Perhaps even send us a patch that fixes
along the way. it! We're happy to help you if you get stuck along the way.
### Capturing a log with ADB ### Capturing a log with ADB

9
README.md
View file

@ -114,6 +114,15 @@ Certificate fingerprints:
[<img width=500 alt="Aegis-icons preview" [<img width=500 alt="Aegis-icons preview"
src="https://raw.githubusercontent.com/krisu5/aegis-icons/master/showcase.png">](https://github.com/krisu5/aegis-icons) src="https://raw.githubusercontent.com/krisu5/aegis-icons/master/showcase.png">](https://github.com/krisu5/aegis-icons)
## Contributing
Looking to contribute to Aegis? That's great! There are a couple of ways to help
out. Translations, bug reports and pull requests are all greatly appreciated.
Please refer to our [contributing guidelines](CONTRIBUTING.md) to get started.
Swing by our Matrix room to interact with other contributors:
[#aegis:matrix.org](https://matrix.to/#/#aegis:matrix.org).
## License ## License
This project is licensed under the GNU General Public License v3.0. See the This project is licensed under the GNU General Public License v3.0. See the