summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorChristoph Wurst <christoph@winzerhof-wurst.at>2018-10-09 10:24:42 +0200
committerChristoph Wurst <christoph@winzerhof-wurst.at>2018-10-09 11:35:46 +0200
commit08b005fb0e5c93ebba79da1084c483c0565ce246 (patch)
tree3ec9987f08e2e56a282d681f7e5f50c61a5678c9 /.github
parenta4e8b4ea561da64a67e976cbc74ecf6497fcdaab (diff)
downloadnextcloud-server-08b005fb0e5c93ebba79da1084c483c0565ce246.tar.gz
nextcloud-server-08b005fb0e5c93ebba79da1084c483c0565ce246.zip
Move GitHub files to .github directory
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md68
-rw-r--r--.github/ISSUE_TEMPLATE.md139
2 files changed, 207 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 00000000000..a8d955042dd
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,68 @@
+## Submitting issues
+
+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].
+
+### Short version
+
+ * 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.
+
+### 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 ([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
+* __SECURITY__: Report any potential security bug to us via [our HackerOne page](https://hackerone.com/nextcloud) or security@nextcloud.com following our [security policy](https://nextcloud.com/security/) instead of filing an issue in our bug tracker.
+* The issues in other components should be reported in their respective repositories: You will find them in our [GitHub Organization](https://github.com/nextcloud/)
+
+* Report the issue using our [template][template], it includes 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.
+
+[template]: ./ISSUE_TEMPLATE.md
+[forum]: https://help.nextcloud.com/
+[irc]: https://webchat.freenode.net/?channels=nextcloud
+
+## Contributing to Source Code
+
+Thanks for wanting to contribute source code to Nextcloud. That's great!
+
+Please read the [Developer Manuals][devmanual] to learn how to create your first application or how to test the Nextcloud code with PHPUnit.
+
+### Tests
+
+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.
+
+### Sign your work
+
+We use the Developer Certificate of Origin (DCO) as a additional safeguard
+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].
+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`. 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.
+
+### 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]
+
+[devmanual]: https://docs.nextcloud.org/server/13/developer_manual/
+[dcofile]: https://github.com/nextcloud/server/blob/master/contribute/developer-certificate-of-origin
+[applyalicense]: https://github.com/nextcloud/server/blob/master/contribute/HowToApplyALicense.md
+
+## Translations
+Please submit translations via [Transifex][transifex].
+
+[transifex]: https://www.transifex.com/nextcloud
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000000..e614ea0aed0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,139 @@
+<!--
+Thanks for reporting issues back to Nextcloud! This is the issue tracker of Nextcloud, if you have any support question please check out https://nextcloud.com/support
+
+This is the bug tracker for the Server component. Find other components at https://github.com/nextcloud/
+
+For reporting potential security issues please see https://nextcloud.com/security/
+
+To make it possible for us to help you please fill out below information carefully.
+You can also use the Issue Template application to prefill most of the required information: https://apps.nextcloud.com/apps/issuetemplate
+
+If you are a customer, please submit your issue directly in the Nextcloud Portal https://portal.nextcloud.com so it gets resolved more quickly by our dedicated engineers.
+
+Note that Nextcloud is an open source project backed by Nextcloud GmbH. Most of our volunteers are home users and thus primarily care about issues that affect home users. Our paid engineers prioritize issues of our customers. If you are neither a home user nor a customer, consider paying somebody to fix your issue, do it yourself or become a customer.
+-->
+### Steps to reproduce
+1.
+2.
+3.
+
+### Expected behaviour
+Tell us what should happen
+
+### Actual behaviour
+Tell us what happens instead
+
+### Server configuration
+
+**Operating system**:
+
+**Web server:**
+
+**Database:**
+
+**PHP version:**
+
+**Nextcloud version:** (see Nextcloud admin page)
+
+**Updated from an older Nextcloud/ownCloud or fresh install:**
+
+**Where did you install Nextcloud from:**
+
+**Signing status:**
+<details>
+<summary>Signing status</summary>
+
+```
+Login as admin user into your Nextcloud and access
+http://example.com/index.php/settings/integrity/failed
+paste the results here.
+```
+</details>
+
+**List of activated apps:**
+<details>
+<summary>App list</summary>
+
+```
+If you have access to your command line run e.g.:
+sudo -u www-data php occ app:list
+from within your Nextcloud installation folder
+```
+</details>
+
+**Nextcloud configuration:**
+<details>
+<summary>Config report</summary>
+
+```
+If you have access to your command line run e.g.:
+sudo -u www-data php occ config:list system
+from within your Nextcloud installation folder
+
+or
+
+Insert your config.php content here.
+Make sure to remove all sensitive content such as passwords. (e.g. database password, passwordsalt, secret, smtp password, …)
+```
+</details>
+
+**Are you using external storage, if yes which one:** local/smb/sftp/...
+
+**Are you using encryption:** yes/no
+
+**Are you using an external user-backend, if yes which one:** LDAP/ActiveDirectory/Webdav/...
+
+#### LDAP configuration (delete this part if not used)
+<details>
+<summary>LDAP config</summary>
+
+```
+With access to your command line run e.g.:
+sudo -u www-data php occ ldap:show-config
+from within your Nextcloud installation folder
+
+Without access to your command line download the data/owncloud.db to your local
+computer or access your SQL server remotely and run the select query:
+SELECT * FROM `oc_appconfig` WHERE `appid` = 'user_ldap';
+
+
+Eventually replace sensitive data as the name/IP-address of your LDAP server or groups.
+```
+</details>
+
+### Client configuration
+**Browser:**
+
+**Operating system:**
+
+### Logs
+#### Web server error log
+<details>
+<summary>Web server error log</summary>
+
+```
+Insert your webserver log here
+```
+</details>
+
+#### Nextcloud log (data/nextcloud.log)
+<details>
+<summary>Nextcloud log</summary>
+
+```
+Insert your Nextcloud log here
+```
+</details>
+
+#### Browser log
+<details>
+<summary>Browser log</summary>
+
+```
+Insert your browser log here, this could for example include:
+
+a) The javascript console log
+b) The network log
+c) ...
+```
+</details>