Skip to content
Snippets Groups Projects
CONTRIBUTING.md 3.78 KiB
Newer Older
  • Learn to ignore specific revisions
  • Lukas Reschke's avatar
    Lukas Reschke committed
    ## Submitting issues
    
    
    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].
    
    Lukas Reschke's avatar
    Lukas Reschke committed
    ### Short version
    
    Lukas Reschke's avatar
    Lukas Reschke committed
     * The [**issue template can be found here**][template] but be aware of the different repositories! See list below. Please always use the issue template when reporting issues.
    
    Lukas Reschke's avatar
    Lukas Reschke committed
    ### Guidelines
    
    * 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
    
    * __SECURITY__: Report any potential security bug to us via [our HackerOne page](https://hackerone.com/owncloud) or security@owncloud.com following our [security policy](https://owncloud.org/security/) instead of filing an issue in our bug tracker
    
    * The issues in other components should be reported in their respective repositories: 
    
    Lukas Reschke's avatar
    Lukas Reschke committed
      - [Android client](https://github.com/owncloud/android/issues)
    
      - [iOS client](https://github.com/owncloud/ios/issues)
      - [Desktop client](https://github.com/owncloud/client/issues)
    
      - [Documentation](https://github.com/owncloud/documentation/issues)
    
    Georg Ehrke's avatar
    Georg Ehrke committed
      - Apps:
    
          - [Activity](https://github.com/owncloud/activity/issues)
    
    Georg Ehrke's avatar
    Georg Ehrke committed
          - [Bookmarks](https://github.com/owncloud/bookmarks/issues)
          - [Calendar](https://github.com/owncloud/calendar/issues)
    
          - [Contacts](https://github.com/owncloud/contacts/issues)
    
          - [Documents](https://github.com/owncloud/documents/issues)
    
          - [Gallery](https://github.com/owncloud/gallery/issues)
    
    Georg Ehrke's avatar
    Georg Ehrke committed
          - [Mail](https://github.com/owncloud/mail/issues)
    
    Morris Jobke's avatar
    Morris Jobke committed
          - [Music](https://github.com/owncloud/music/issues)
    
    Georg Ehrke's avatar
    Georg Ehrke committed
          - [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.
    
    Lukas Reschke's avatar
    Lukas Reschke committed
    
    Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
    
    
    Lukas Reschke's avatar
    Lukas Reschke committed
    [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
    
    Lukas Reschke's avatar
    Lukas Reschke committed
    
    ## 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].
    
    
    Please read the [Developer Manuals][devmanual] to learn how to create your first application or how to test the ownCloud code with PHPUnit.
    
    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
    
    Lukas Reschke's avatar
    Lukas Reschke committed
    
    ## Translations
    Please submit translations via [Transifex][transifex].
    
    [transifex]: https://www.transifex.com/projects/p/owncloud/