From bd2cbaf7d7d9b51d03f050e26cf40d47857ef61a Mon Sep 17 00:00:00 2001 From: Daniel Persson Date: Wed, 31 Jul 2019 12:06:50 +0200 Subject: [PATCH 1/3] Adding contributing agreement --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f0c5d4e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing to Secure Quick Reliable Login. + +First of thank you for considering helping out with this project. All contributions are welcome, we want this project to +reach completion with a full implementation of the SQRL specification. + +### I want to file a bug. + +Then you open an issue under [issues](https://github.com/kalaspuffar/secure-quick-reliable-login/issues) and follow the +guide there. Please search before you post so we get as few duplicates as possible. + +### I want to suggest a feature. + +Then you open an issue under [issues](https://github.com/kalaspuffar/secure-quick-reliable-login/issues) and follow the +guide there. Please search before you post so we get as few duplicates as possible. + +### Code style + +We are trying to keep an consistant coding convention in order to help readablility and make it easy to submit code. + +Things to refrain from: + * Different indentation in the same file + * Too long lines 200 chars+ + * All curly brackets starts at the same line as function, class, method, expression, what ever. + * All curly brackets ends on a new line. From a83f206d720be5a97467d26742c352654c1620cd Mon Sep 17 00:00:00 2001 From: Daniel Persson Date: Thu, 1 Aug 2019 10:32:39 +0200 Subject: [PATCH 2/3] Improved wording. --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f0c5d4e..d43e043 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,8 +17,8 @@ guide there. Please search before you post so we get as few duplicates as possib We are trying to keep an consistant coding convention in order to help readablility and make it easy to submit code. -Things to refrain from: - * Different indentation in the same file - * Too long lines 200 chars+ +Try to stick to: + * The same indentation in the same file + * Shorter lines, 200 chars+ can be hard to read in all editors and makes code less readable. * All curly brackets starts at the same line as function, class, method, expression, what ever. * All curly brackets ends on a new line. From 2afa233d8f74609b84f7bad12fde249fdaa68980 Mon Sep 17 00:00:00 2001 From: Daniel Persson Date: Thu, 1 Aug 2019 12:23:29 +0200 Subject: [PATCH 3/3] Updated with suggestions from Joel. --- CONTRIBUTING.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d43e043..78aa27d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,32 @@ -# Contributing to Secure Quick Reliable Login. +# Contributing to Dotify. -First of thank you for considering helping out with this project. All contributions are welcome, we want this project to -reach completion with a full implementation of the SQRL specification. +First of thank you for considering helping out with this project. All contributions are welcome. Here's what you can do to make the process as smooth and efficient as possible. ### I want to file a bug. -Then you open an issue under [issues](https://github.com/kalaspuffar/secure-quick-reliable-login/issues) and follow the +Then you open an issue under [issues](https://github.com/brailleapps/dotify.translator.impl/issues) and follow the guide there. Please search before you post so we get as few duplicates as possible. ### I want to suggest a feature. -Then you open an issue under [issues](https://github.com/kalaspuffar/secure-quick-reliable-login/issues) and follow the +Then you open an issue under [issues](https://github.com/brailleapps/dotify.translator.impl/issues) and follow the guide there. Please search before you post so we get as few duplicates as possible. +### I want to contribute code. + +Before you begin if you are a new contributor it's helpful for you to visit our wiki at [wiki](https://github.com/brailleapps/wiki/wiki) there you can find extensive documentation and other helpful information that can help you make a contribution. + +1. Create an issue describing the problem you're having or the feature you need. Try to be clear, concise and descriptive. +1. Unless the issue you're having is trivial, you should discuss with the team about possible solutions before you begin working on it. Discussions should be held on Github or replicated so other interested parties can contribute with their knowledge and follow progress. +1. Solve the problem. Unless there is a good reason not to, you should follow applicable guidelines and conventions, for example the [Principles](https://github.com/brailleapps/wiki/wiki/Principles). +1. Rebase your change so that it is ahead of the current master. +1. Make sure that your change works by running all applicable tests. +1. Make a PR and ask for a review. + +That's it! If there are issues with your change, the team will contact you. If the current master has moved and it conflicts with your PR, you might be asked to rebase it again. You're responsible for resolving any conflicts with master until your PR has been merged. + ### Code style We are trying to keep an consistant coding convention in order to help readablility and make it easy to submit code. -Try to stick to: - * The same indentation in the same file - * Shorter lines, 200 chars+ can be hard to read in all editors and makes code less readable. - * All curly brackets starts at the same line as function, class, method, expression, what ever. - * All curly brackets ends on a new line. +More in-depth guidelines can be found at [Principles](https://github.com/brailleapps/wiki/wiki/Principles)