nextcloud/CONTRIBUTING.md

62 lines
3.5 KiB
Markdown
Raw Normal View History

2013-01-11 21:57:56 +04:00
## Submitting issues
2013-06-04 03:43:43 +04:00
If you have questions about how to install or use ownCloud, please direct these to the [mailing list][mailinglist] or our [forum][forum]. We are also available on [IRC][irc].
2013-01-11 21:57:56 +04:00
### TL;DR
2013-06-13 23:35:32 +04:00
* The [issue template can be found here][template] but be aware of the different repositories! See list below.
2013-01-11 21:57:56 +04:00
### Guidelines
2013-06-04 03:43:43 +04:00
* Please search the existing issues first, it's likely that your issue was already reported or even fixed.
- 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)
* This repository ([core](https://github.com/owncloud/core/issues)) is *only* for issues within the ownCloud core code. This also includes the apps: files, encryption, external storage, sharing, deleted files, versions, LDAP, and WebDAV Auth
2013-06-04 03:43:43 +04:00
* The issues in other components should be reported in their respective repositories:
2013-01-12 01:22:08 +04:00
- [Android client](https://github.com/owncloud/android/issues)
- [iOS client](https://github.com/owncloud/ios-issues/issues)
- [Desktop client](https://github.com/owncloud/mirall/issues)
- [Documentation](https://github.com/owncloud/documentation/issues)
2013-04-13 22:00:39 +04:00
- Apps:
- [Activity](https://github.com/owncloud/activity/issues)
2013-04-13 22:00:39 +04:00
- [Bookmarks](https://github.com/owncloud/bookmarks/issues)
- [Calendar](https://github.com/owncloud/calendar/issues)
2013-05-15 15:53:15 +04:00
- [Contacts](https://github.com/owncloud/contacts/issues)
2013-10-31 14:16:56 +04:00
- [Documents](https://github.com/owncloud/documents/issues)
- [Gallery](https://github.com/owncloud/gallery/issues)
2013-04-13 22:00:39 +04:00
- [Mail](https://github.com/owncloud/mail/issues)
2014-08-20 11:50:00 +04:00
- [Music](https://github.com/owncloud/music/issues)
2013-04-13 22:00:39 +04:00
- [News](https://github.com/owncloud/news/issues)
- [Notes](https://github.com/owncloud/notes/issues)
- [Shorty](https://github.com/owncloud/shorty/issues)
- [Tasks](https://github.com/owncloud/tasks/issues)
- [All other apps](https://github.com/owncloud/apps/issues)
* Report the issue using our [template][template], it includes all the information we need to track down the issue.
2013-01-11 21:57:56 +04:00
Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
2013-01-12 18:19:12 +04:00
[template]: https://raw.github.com/owncloud/core/master/issue_template.md
[mailinglist]: https://mailman.owncloud.org/mailman/listinfo/owncloud
[forum]: https://forum.owncloud.org/
[irc]: https://webchat.freenode.net/?channels=owncloud&uio=d4
2013-01-11 21:57:56 +04:00
## Contributing to Source Code
Thanks for wanting to contribute source code to ownCloud. That's great!
Before we're able to merge your code into the ownCloud core, you need to sign our [Contributor Agreement][agreement].
2013-06-04 03:43:43 +04:00
Please read the [Developer Manuals][devmanual] to learn how to create your first application or how to test the ownCloud code with PHPUnit.
2013-01-11 21:57:56 +04: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.
[agreement]: https://owncloud.org/about/contributor-agreement/
[devmanual]: https://owncloud.org/dev
2013-01-11 21:59:56 +04:00
## Translations
Please submit translations via [Transifex][transifex].
[transifex]: https://www.transifex.com/projects/p/owncloud/