7876a79624
Signed-off-by: Pedro Pinto Silva <pedro.silva@collabora.com> Change-Id: Ie048bdd6097197cbf176bfaaa7206335dde195e2
53 lines
3.8 KiB
Markdown
53 lines
3.8 KiB
Markdown
# 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][report] using one of our 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.
|
|
|
|
[report]: https://github.com/CollaboraOnline/online/issues/new/choose
|
|
[forum]: https://forum.collaboraonline.com/
|
|
[irc]: https://web.libera.chat/?channels=cool-dev
|
|
[telegram]: https://t.me/CollaboraOnline
|
|
|
|
## Contributing to Source Code
|
|
|
|
Thanks for wanting to contribute source code to Collabora Online. You rock!
|
|
|
|
1. Just [fork the main repo](https://github.com/CollaboraOnline/online/fork)
|
|
2. 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))
|
|
3. Grab one of our newcomer-friendly [easy hacks](https://collaboraonline.github.io/post/easyhacks/)
|
|
4. Send your [first pull request](https://forum.collaboraonline.com/t/your-first-pull-request/41)
|
|
5. Check master branch [current status](https://github.com/CollaboraOnline/online#readme)
|
|
-  Try to get at least one +1 as a reaction, comment or approval from someone else before merging it
|
|
-  It's required to have approval from someone before your PR can be merged
|
|
|
|
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).
|