2013-01-11 17:57:56 +00:00
## Submitting issues
2016-06-12 07:56:22 +00:00
If you have questions about how to install or use Nextcloud, please direct these to our [forum][forum]. We are also available on [IRC][irc].
2013-01-11 17:57:56 +00:00
2015-04-27 13:39:37 +00:00
### Short version
2013-06-12 19:58:19 +00:00
2019-01-25 07:46:43 +00:00
* The [**issue templates can be found here**][templates] but be aware of the different repositories! See list below. Please always use an issue template when reporting issues.
2013-06-12 19:58:19 +00:00
2013-01-11 17:57:56 +00:00
### Guidelines
2013-06-03 23:43:43 +00:00
* Please search the existing issues first, it's likely that your issue was already reported or even fixed.
2013-10-23 12:21:28 +00:00
- Go to one of the repositories, 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 )
2016-07-23 08:50:00 +00:00
* This repository ([server](https://github.com/nextcloud/server/issues)) is *only* for issues within the Nextcloud Server code. This also includes the apps: files, encryption, external storage, sharing, deleted files, versions, LDAP, and WebDAV Auth
2019-11-15 11:03:50 +00:00
* __SECURITY__: Report any potential security bug to us via [our HackerOne page ](https://hackerone.com/nextcloud ) following our [security policy ](https://nextcloud.com/security/ ) instead of filing an issue in our bug tracker.
2016-06-12 07:47:50 +00:00
* The issues in other components should be reported in their respective repositories: You will find them in our [GitHub Organization ](https://github.com/nextcloud/ )
2015-12-16 12:58:18 +00:00
2019-01-25 07:46:43 +00:00
* Report the issue using one of our [templates][templates], they include all the information we need to track down the issue.
2013-01-11 17:57:56 +00:00
Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
2019-01-25 07:46:43 +00:00
[templates]: ./ISSUE_TEMPLATE
2016-06-12 07:47:50 +00:00
[forum]: https://help.nextcloud.com/
[irc]: https://webchat.freenode.net/?channels=nextcloud
2013-01-11 17:57:56 +00:00
## Contributing to Source Code
2016-06-12 07:47:50 +00:00
Thanks for wanting to contribute source code to Nextcloud. That's great!
2013-01-11 17:57:56 +00:00
2016-06-24 08:44:28 +00:00
Please read the [Developer Manuals][devmanual] to learn how to create your first application or how to test the Nextcloud code with PHPUnit.
2013-01-11 17:57:56 +00:00
2016-09-21 09:23:51 +00:00
### Tests
2015-01-21 10:15:32 +00:00
In order to constantly increase the quality of our software we can no longer accept pull request which submit un-tested code.
It is a must have that changed and added code segments are unit tested.
In some areas unit testing is hard (aka almost impossible) as of today - in these areas refactoring WHILE fixing a bug is encouraged to enable unit testing.
2016-09-21 09:23:51 +00:00
### Sign your work
We use the Developer Certificate of Origin (DCO) as a additional safeguard
2016-09-29 14:03:37 +00:00
for the Nextcloud 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 [contribute/developer-certificate-of-origin][dcofile].
2016-09-21 09:23:51 +00:00
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
2016-09-29 14:03:37 +00:00
commit automatically with `git commit -s` . You can also use git [aliases ](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases )
like `git config --global alias.ci 'commit -s'` . Now you can commit with
`git ci` and the commit will be signed.
2016-09-21 09:23:51 +00:00
### Apply a license
In case you are not sure how to add or update the license header correctly please have a look at [contribute/HowToApplyALicense.md][applyalicense]
2019-04-12 16:48:50 +00:00
[devmanual]: https://docs.nextcloud.com/server/latest/developer_manual/
2016-09-21 09:23:51 +00:00
[dcofile]: https://github.com/nextcloud/server/blob/master/contribute/developer-certificate-of-origin
[applyalicense]: https://github.com/nextcloud/server/blob/master/contribute/HowToApplyALicense.md
2013-01-11 17:59:56 +00:00
## Translations
Please submit translations via [Transifex][transifex].
2016-07-02 12:21:01 +00:00
[transifex]: https://www.transifex.com/nextcloud