From 592640addf410e8d8ff12b84c1469099a12e380c Mon Sep 17 00:00:00 2001 From: Konstantinos Sideris Date: Mon, 14 May 2018 15:08:44 +0300 Subject: [PATCH] Add contributing document --- .github/CONTRIBUTING | 39 +++++++++++++++++++++++++++++++++++++++ README.md | 3 +-- 2 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 .github/CONTRIBUTING diff --git a/.github/CONTRIBUTING b/.github/CONTRIBUTING new file mode 100644 index 00000000..706b00cc --- /dev/null +++ b/.github/CONTRIBUTING @@ -0,0 +1,39 @@ +## Contributing to nheko + +Any kind of contribution to the project is greatly appreciated. + +- Bug fixes +- Implementing new features +- UI/UX improvements/suggestions +- Code refactoring +- Translations + +### Working on new features + +Everything on the issue tracker is up for grabs unless someone else is +currently working on it. + +If you're planning to work on a new feature leave a message on the Matrix room +(or in the corresponding issue), so we won't end up having duplicate work. + +### Submitting a translation + +Example for a Japanese translation. +- Create a new translation file using the prototype in English + - e.g `cp resources/langs/nheko_en.ts resources/langs/nheko_jp.ts` +- Open the new translation file and change the line regarding the locale to reflect the current language. + - e.g `` => `` +- Run `make update-translations` to update the translation files with any missing text. +- Fill out the translation file (Qt Linguist can make things easier). +- Submit a PR! + + +### Code style + +We use clang-format to enforce a certain style as defined by the `.clang-format` +file in the root of the repo. Travis-CI will run the linter (macOS job) on each +commit and the build will fail if the style guide isn't followed. You can run the +linter locally with `make lint`. + + +If you have any questions don't hesitate to reach out to us on #nheko:matrix.org. diff --git a/README.md b/README.md index 7978c5fe..92e0eb44 100644 --- a/README.md +++ b/README.md @@ -163,8 +163,7 @@ You can also install nheko by running `nix-env -f . -i` ### Contributing -Any kind of contribution to the project is greatly appreciated. You are also -encouraged to open feature request issues. +See [CONTRIBUTING](.github/CONTRIBUTING) ### Screens