From 7b2215b8824295efaa77eea61a4d4eed4cd77ca3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Mon, 24 Oct 2016 19:01:52 +0200 Subject: Add a CONTRIBUTING file --- CONTRIBUTING.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 CONTRIBUTING.rst (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..f80b4a9 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,44 @@ +Contributing to biboumi +======================= + +Biboumi’s main workplace is at https://lab.louiz.org/louiz/biboumi + +The repository is also mirrored on other websites, for example on github, but +that’s mainly for the convenience of users. + +Before doing anything, you can come on the `XMPP chatroom`_ to discuss your +changes, issues or ideas. + +Bug reports, feature requests +----------------------------- +To open a bug report, or a feature request, please do so on +`our gitlab’s bug tracker`_. + +If the issue you’re reporting may have security implications, please select +the “confidential” flag in your bug report. + + +Code +---- +To contribute code, you can do so using git: commit your changes on any +publicly available git repository and communicate us its address. This +can be done with a `gitlab merge request`_, or a `github pull request`_ +or just by sending a message into the `XMPP chatroom`_. + + +Coding style +------------ +Please try to follow the existing style: + +- Use only spaces, not tabs. +- Curly brackets are on their own lines. +- Use this-> everywhere it’s possible. +- Don’t start class attributes with “m_” or similar. +- Type names are in PascalCase. +- Everything else is in snake_case. + + +.. _our gitlab’s bug tracker: https://lab.louiz.org/louiz/biboumi/issues/new +.. _gitlab merge request: https://lab.louiz.org/louiz/biboumi/merge_requests/new +.. _github pull request: https://github.com/louiz/biboumi/pulls +.. _XMPP chatroom: xmpp:biboumi@muc.poez.io -- cgit v1.2.3 From 00a2e8dd706e523ca0d6543d2c4b604b4ed3cdcb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Mon, 24 Oct 2016 19:22:46 +0200 Subject: Suggest adding tests when contributing --- CONTRIBUTING.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f80b4a9..dfafa89 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -25,6 +25,12 @@ publicly available git repository and communicate us its address. This can be done with a `gitlab merge request`_, or a `github pull request`_ or just by sending a message into the `XMPP chatroom`_. +It is suggested that you use gitlab’s merge requests: this will automatically +run our continuous integration tests. + +It is also recommended to add some unit or end-to-end tests for the prosposed +changes. + Coding style ------------ -- cgit v1.2.3 From 5ffd976d7f36d7db530c1a518e4a5911404b4ba1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Tue, 25 Oct 2016 01:17:58 +0200 Subject: CONTRIBUTING.rst formatting and a typo --- CONTRIBUTING.rst | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index dfafa89..ed3915f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -3,16 +3,17 @@ Contributing to biboumi Biboumi’s main workplace is at https://lab.louiz.org/louiz/biboumi -The repository is also mirrored on other websites, for example on github, but -that’s mainly for the convenience of users. +The repository is also mirrored on other websites, for example on github, +but that’s mainly for the convenience of users. Before doing anything, you can come on the `XMPP chatroom`_ to discuss your changes, issues or ideas. Bug reports, feature requests ----------------------------- -To open a bug report, or a feature request, please do so on -`our gitlab’s bug tracker`_. + +To open a bug report, or a feature request, please do so on `our gitlab’s +bug tracker`_. If the issue you’re reporting may have security implications, please select the “confidential” flag in your bug report. @@ -20,15 +21,16 @@ the “confidential” flag in your bug report. Code ---- + To contribute code, you can do so using git: commit your changes on any -publicly available git repository and communicate us its address. This -can be done with a `gitlab merge request`_, or a `github pull request`_ -or just by sending a message into the `XMPP chatroom`_. +publicly available git repository and communicate us its address. This can +be done with a `gitlab merge request`_, or a `github pull request`_ or just +by sending a message into the `XMPP chatroom`_. -It is suggested that you use gitlab’s merge requests: this will automatically -run our continuous integration tests. +It is suggested that you use gitlab’s merge requests: this will +automatically run our continuous integration tests. -It is also recommended to add some unit or end-to-end tests for the prosposed +It is also recommended to add some unit or end-to-end tests for the proposed changes. -- cgit v1.2.3