diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..18bba2730fa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing + +## I want to contribute to Wire + +You can contribute to Wire in several ways: + +## Finding bugs + +If you find a bug in how Wire apps work, please submit a ticket to [our support](https://support.wire.com) and we will keep you informed about the progress. +Alternatively, you can submit your finding on [wire issues](https://github.com/wireapp/wire/issues). Please make sure to provide as much information as possible to help us reproduce the issue. + +## Contributing to the code + +If you wish to contribute source code to one of our repositories you have to sign +our [Contributor Agreement](https://github.com/wireapp/wire/raw/master/assets/Wire%20Contributor%20Agreement.pdf) +first. + +When you submit your first pull request, you can sign the agreement electronically by filling in the +required information. You will not have to sign it again for subsequent pull requests from the same +GitHub account. + +When opening a pull request, please make sure to follow the next guidelines: + +- Make sure to fill in the pull request template to the fullest extent possible, this will help us + understand faster the changes proposed. +- Make sure to run the tests and linters before submitting the pull request. +- Add the necessary tests for the changes you are proposing, this will help us ensure that the + changes are working as expected. + +> [!NOTE] +> We accept only bug fixes and code improvements. We cannot accept new features, UI or UX changes – these are decided by Wire and built by the Wire development team. + +## I want to help translate Wire + +If you want to help Wire to speak more languages, please refer to our [site](https://support.wire.com/hc/en-us/articles/202856874-Language-support), to see the official list of supported languages and those who are open to contribute. + +To do so, you will find instructions there, but you can do the following: + +1. Create a [Crowdin account](https://crowdin.com/). +2. Request access to add translations in our [project](https://crowdin.com/project/wire-android-reloaded). +3. Translate away. diff --git a/README.md b/README.md index 6bf98626d1e..503d525dfeb 100644 --- a/README.md +++ b/README.md @@ -61,16 +61,6 @@ It might be that after cloning the Android project, some build issues appear on - There is a valid SDK path on your `local.properties` AND `kalium/local.properties` files pointing to the Android SDK folder. In Mac, that folder can be usually found under `sdk.dir=/Users/YOUR_USER_FOLDER/Library/Android/sdk`. The IDE **will not** create `kalium/local.properties` automatically, so you might want to copy/paste the one in the project root - When you've already started working on the project adding some commits, it might occur that your local build breaks, if that is the case, make sure you've updated the `kalium` submodule reference by running: `git submodule update --remote --merge` -## Contributing - -If you want to help Wire to speak more languages, please refer to our [site](https://support.wire.com/hc/en-us/articles/202856874-Language-support), to see the official list of supported languages and those who are open to contribute. - -To do so, you will find instructions there, but you can do the following: - -1. Create a [Crowdin account](https://crowdin.com/). -2. Request access to add translations in our [project](https://crowdin.com/project/wire-android-reloaded). -3. Translate away. - # App flavours We have a few different app flavours with different intended usages. Each app flavour has a different icon background colour to enable easier distinction. @@ -99,3 +89,7 @@ To see how they are customised in details, check [the flavour configuration file ## Build Types The apps can be built for release or debugging. Debug versions might have extra debugging tools, are not minified, and can be profiled if needed. In general, debug builds _run slower_ due to the lack of minimisation. + +## Contributing + +If you want to contribute to Wire for Android, please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more information.