forked from owncloud/core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Klaas Freitag
committed
Aug 27, 2021
1 parent
75b9b38
commit 57940b1
Showing
1 changed file
with
67 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,86 @@ | ||
| ## Submitting issues | ||
| First of all, thank you for taking the time to read this and your interest in contributing to ownCloud. | ||
|
|
||
| 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]. | ||
| The following is a set of guidelines for contributing to most of the projects hosted in the [ownCloud Organization](https://github.com/owncloud) on [GitHub](https://www.github.com). These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
|
||
| ### Short version | ||
| ## I don't want to read this whole thing I just have a question | ||
|
|
||
| * 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. | ||
| > **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below. | ||
| ### 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, external storage, sharing, deleted files, versions, comments, tags and WebDAV Auth | ||
| * __SECURITY__: Report any potential security bug to us via [our HackerOne page](https://hackerone.com/owncloud) or [email protected] following our [security policy](https://owncloud.com/security/) instead of filing an issue in our bug tracker | ||
| * The issues in other components should be reported in their respective repositories: | ||
| - [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) | ||
| - [ownCloud apps](https://github.com/owncloud/core/wiki/Maintainers#apps-repo) | ||
| For general questions, please refer to [ownCloud's FAQs](https://owncloud.com/faq/) or ask on the [ownCloud Central Server](https://central.owncloud.org/). | ||
|
|
||
| * Report the issue using our [template][template], it includes all the information we need to track down the issue. | ||
| We also have a [Rocket Chat Server](https://talk.owncloud.com/channel/general) to answer your questions. | ||
| There is also an [IRC channel](https://webchat.freenode.net/?channels=owncloud&uio=d4). | ||
|
|
||
| Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. | ||
| ## Reporting Bugs | ||
|
|
||
| This section guides you through submitting a bug report for ownCloud. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:. | ||
|
|
||
| Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/owncloud/core/issues/new?Type%3ABug&template=issue_template.md), the information it asks for helps us resolve issues faster. | ||
|
|
||
| > **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. If you have permission to reopen the issue, feel free to do so. | ||
| #### Before Submitting A Bug Report | ||
|
|
||
| * **Make sure you are running a recent version** Usually, developers' interest in old versions of software drops very fast once a new shiny version has been released. So the general recommendation is: Use the latest released version or even the current master to reproduce problems that you might encounter. That helps a lot to attract developers attention. | ||
| * **Determine which [repository](https://github.com/owncloud) the problem should be reported in**. | ||
| * **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Aowncloud)** with possibly a more granular filter on the repository, to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one **if you have new information**. Please abstain from adding "plus ones", except using the Github emojis. That might indicate how many users are affected. | ||
|
|
||
| #### How Do I Submit A (Good) Bug Report | ||
|
|
||
| Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined [which repository](https://github.com/owncloud) your bug is related to, create an issue on that repository and provide the following information by filling in [the template](https://github.com/owncloud/core/issues/new?Type%3ABug&template=issue_template.md). | ||
|
|
||
| Explain the problem and include additional details to help maintainers reproduce the problem: | ||
|
|
||
| * **Use a clear and descriptive title** for the issue to identify the problem. | ||
| * **Describe the exact steps which reproduce the problem** in as many details as possible. Start with describing, from a user perspective, what you tried to achieve, i.e. "I want to share some pictures with Grandma". When listing steps, **don't just say what you did, but explain how you did it**. For example, if you uploaded a file to ownCloud, say which client you used, which way of uploading you chose, if the name was special somehow and how big it was. | ||
| * **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). | ||
| * **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. | ||
| * **Explain which behavior you expected to see instead and why.** | ||
| * **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. | ||
| * **If you report a web browser related problem**, consider to using the browser's Web developer tools (such as the debugger, console or network monitor) to check what happened. Make sure to add screenshots of the utilities if you are short of time to interpret it. | ||
| * **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below. | ||
|
|
||
| Provide more context by answering these questions: | ||
|
|
||
| * **Did the problem start happening recently** (e.g. after updating to a new version) or was this always a problem? | ||
| * If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen? | ||
| * **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens. | ||
|
|
||
| Include details about your configuration and environment as asked for in the template. | ||
|
|
||
| ### Suggesting Enhancements | ||
|
|
||
| This section guides you through submitting an enhancement suggestion for ownCloud, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:. | ||
|
|
||
| Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). | ||
|
|
||
| #### Before Submitting An Enhancement Suggestion | ||
|
|
||
| * **Check if there's already an extension or other component which provides that enhancement, even in a different way.** | ||
| * **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Aowncloud)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. Feel free to use the Github emojis to indicate that you are in favour of an enhancement request. | ||
|
|
||
| #### How Do I Submit A (Good) Enhancement Suggestion | ||
|
|
||
| Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined [which repository](https://github.com/owncloud) your enhancement suggestion is related to, create an issue on that repository and provide the following information: | ||
|
|
||
| * **Use a clear and descriptive title** for the issue to identify the suggestion. | ||
| * **Provide a step-by-step description of the suggested enhancement** in as many details as possible. | ||
| * **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). | ||
| * **Explain why this enhancement would be useful** to most ownCloud users. | ||
| * **List some other projects or products where this enhancement exists.** | ||
|
|
||
| [template]: https://raw.github.com/owncloud/core/master/.github/issue_template.md | ||
| [forum]: https://central.owncloud.org/ | ||
| [irc]: https://webchat.freenode.net/?channels=owncloud&uio=d4 | ||
|
|
||
| ## 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]. | ||
| Before we're able to merge your code into the ownCloud core, you need to sign our [Contributors License Agreement](https://owncloud.com/contribute/join-the-development/contributor-agreement/). | ||
|
|
||
| Please read the [Developer Manuals][devmanual] to learn how to create your first application or how to test the ownCloud code with PHPUnit. | ||
| Please read the [Developer Manuals](https://doc.owncloud.com/server/developer_manual/) 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 requests 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.com/contribute/join-the-development/contributor-agreement/ | ||
| [devmanual]: https://doc.owncloud.com/server/developer_manual/ | ||
|
|
||
| ## Translations | ||
| Please submit translations via [Transifex][transifex]. | ||
|
|
||
| [transifex]: https://www.transifex.com/projects/p/owncloud/ | ||
| Please submit translations via [Transifex](https://www.transifex.com/projects/p/owncloud/) |