From 83df998f56779e98700dc388d0af40b8ae741acc Mon Sep 17 00:00:00 2001 From: Muhammet Kara Date: Mon, 26 Oct 2020 05:09:48 +0300 Subject: 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 Change-Id: Ic408627e39d565f006c6f8591e110bcc9e97c17e --- CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') 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 +```` + +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). -- cgit