summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMuhammet Kara <mrkara@users.noreply.github.com>2020-10-26 05:09:48 +0300
committerMuhammet Kara <mrkara@users.noreply.github.com>2020-10-26 05:45:29 +0300
commit83df998f56779e98700dc388d0af40b8ae741acc (patch)
tree817e0fd1662c7eefcb0f2338c609aad5f24c64d3 /CONTRIBUTING.md
parentRemove Poco/TimeStamp.h left-over (diff)
downloadonline-83df998f56779e98700dc388d0af40b8ae741acc.tar.gz
online-83df998f56779e98700dc388d0af40b8ae741acc.zip
Create CONTRIBUTING.md
As recommended by the GitHub Community Guidelines. It is recognized by file name and featured to contributors automatically in various ways. Signed-off-by: Muhammet Kara <muhammet.kara@collabora.com> Change-Id: Ic408627e39d565f006c6f8591e110bcc9e97c17e
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000..85089443ce
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,45 @@
+# Contributing to Collabora Online
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+The following is a set of rules and guidelines for contributing to Collabora Online. Please feel free to propose changes to this document in a pull request.
+
+
+## Submitting issues
+
+If you have questions about how to install or use Collabora Online, please direct these to our [forum][forum].
+If you have issues or questions about Collabora Online development, you may join us on [IRC][irc] or [Telegram][telegram].
+
+### Guidelines
+* Please search the existing issues first, it's likely that your issue was already reported or even fixed.
+ - Go to the main page of the repository, click "issues" and type any word in the top search/command bar.
+ - You can also filter by appending e. g. "state:open" to the search string.
+ - More info on [search syntax within github](https://help.github.com/articles/searching-issues)
+* __SECURITY__: Report any potential security bug to us following our [security policy](https://github.com/CollaboraOnline/online/security/policy) instead of filing an issue in our bug tracker.
+
+* Report the issue using one of our [templates][templates], they include all the information we need to track down the issue.
+
+Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
+
+[templates]: ./ISSUE_TEMPLATE
+[forum]: https://forum.collaboraonline.com/
+[irc]: https://webchat.freenode.net/?channels=cool-dev
+[telegram]: https://t.me/CollaboraOnline
+
+## Contributing to Source Code
+
+Thanks for wanting to contribute source code to Collabora Online. You rock!
+
+Just [fork the main repo](https://github.com/CollaboraOnline/online/fork), build it ([on Linux](https://collaboraonline.github.io/post/build-code/) or [on any platform](https://forum.collaboraonline.com/t/start-developing-cool-on-any-platform-in-5-minutes/52)), grab one of our newcomer-friendly [easy hacks](https://collaboraonline.github.io/post/easyhacks/), and [send your first pull request](https://forum.collaboraonline.com/t/your-first-pull-request/41). And if you get stuck at any point, just drop by one of our [communication channels](https://collaboraonline.github.io/post/communicate/).
+
+### Sign your work
+
+We use the Developer Certificate of Origin (DCO) as a additional safeguard for the Collabora Online project. This is a well established and widely used mechanism to assure contributors have confirmed their right to license their contribution under the project's license. Please read [README.CONTRIBUTING.md](README.CONTRIBUTING.md). If you can certify it, then just add a line to every git commit message:
+
+````
+ Signed-off-by: Random J Developer <random@developer.example.org>
+````
+
+Use your real name (sorry, no pseudonyms or anonymous contributions). If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`.
+
+## Translations
+Please submit translations via [Weblate](https://hosted.weblate.org/projects/collabora-online).