Browse Source

Updated issue templates, code of conduct, and contributing [ci skip]

Tobias Hagemann 5 years ago
parent
commit
8db856855e

+ 15 - 13
.github/CODE_OF_CONDUCT.md

@@ -5,9 +5,9 @@
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
@@ -23,7 +23,7 @@ include:
 Examples of unacceptable behavior by participants include:
 
 * The use of sexualized language or imagery and unwelcome sexual attention or
-advances
+  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
@@ -45,12 +45,12 @@ threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 
@@ -68,7 +68,9 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

+ 2 - 2
.github/CONTRIBUTING.md

@@ -5,7 +5,7 @@
 - Ensure you're running the latest version of Cryptomator.
 - Ensure the bug is related to the desktop version of Cryptomator. Bugs concerning the Cryptomator iOS and Android app can be reported on the [Cryptomator for iOS issues list](https://github.com/cryptomator/cryptomator-ios/issues) and [Cryptomator for Android issues list](https://github.com/cryptomator/cryptomator-android/issues) respectively.
 - Ensure the bug was not [already reported](https://github.com/cryptomator/cryptomator/issues). You can also check out our [FAQ](https://community.cryptomator.org/c/kb/faq).
-- If you're unable to find an open issue addressing the problem, [submit a new one](https://github.com/cryptomator/cryptomator/issues/new).
+- If you're unable to find an open issue addressing the problem, [submit a new one](https://github.com/cryptomator/cryptomator/issues/new/choose).
 
 ## Did you write a patch that fixes a bug?
 
@@ -14,7 +14,7 @@
 
 ## Do you intend to add a new feature or change an existing one?
 
-- Suggest your change by [submitting a new issue](https://github.com/cryptomator/cryptomator/issues/new) and start writing code.
+- Suggest your change by [submitting a new issue](https://github.com/cryptomator/cryptomator/issues/new/choose) and start writing code.
 
 ## Code of Conduct
 

+ 25 - 20
.github/ISSUE_TEMPLATE/bug.md

@@ -1,6 +1,6 @@
 ---
 name: "Bug Report"
-about:  "Create a report to help us improve"
+about: "Create a report to help us improve"
 labels: type:bug
 ---
 
@@ -11,46 +11,51 @@ We're happy to help you via our support channels! Please read: https://github.co
 
 By filing an issue, you are expected to comply with our code of conduct: https://github.com/cryptomator/cryptomator/blob/develop/.github/CODE_OF_CONDUCT.md
 
-Of course we also expect you to search for existing similar issues, first! ;) https://github.com/cryptomator/cryptomator/issues?q=
+Of course, we also expect you to search for existing similar issues first! ;) https://github.com/cryptomator/cryptomator/issues?q=
 
 -->
 
 ### Description
 
-[Summarize your problem]
+[Summarize your problem.]
 
 ### System Setup
 
-* Operating system and version:
-* Cryptomator version (shown in the settings):
-* Drive (FUSE/Dokany/WebDAV):
+* Operating system and version: [Windows/macOS/Linux + Version]
+* Cryptomator version: [Shown in the settings]
+* Drive: [Dokany/FUSE/WebDAV]
 
 ### Steps to Reproduce
 
-1. [First Step]
-2. [Second Step]
-3. [and so on...]
+1. [First step]
+2. [Second step]
+3. [and so on]
 
-#### Expected behavior:
-[What you expect to happen]
+#### Expected Behavior
 
-#### Actual behavior
-[What actually happens]
+[What you expect to happen.]
 
-#### Reproduces how often:
-[What percentage of the time does it reproduce?]
+#### Actual Behavior
+
+[What actually happens.]
+
+#### Reproducibility
+
+[Always/Intermittent/Only once]
 
 ### Additional Information
 
-Any additional information, log files, screenshots, configuration or data that might be necessary to reproduce the issue.
+[Any additional information, log files, screenshots, configuration, or data that might be necessary to reproduce the issue.]
 
 <!--
+
 If you want to add the log file or screenshots, please add them as attachments. If your log file seems empty and doesn't show any errors, you may enable the debug mode first. Here is how to do that: https://community.cryptomator.org/t/how-do-i-enable-debug-mode/36
 
 Then reproduce the problem to ensure all important information is contained in there. You may use test data or redact sensitive information from the log file.
 
-You can find the log file
-- on Windows: %appdata%/Cryptomator/cryptomator.log
-- on macOS: ~/Library/Logs/Cryptomator/cryptomator.log
-- on Linux: ~/.Cryptomator/cryptomator.log
+Log file location:
+- Windows: %appdata%/Cryptomator
+- macOS: ~/Library/Logs/Cryptomator
+- Linux: ~/.local/share/Cryptomator/logs
+
 -->

+ 8 - 8
.github/ISSUE_TEMPLATE/feature.md

@@ -1,6 +1,6 @@
 ---
 name: "Feature Request"
-about:  "Suggest an idea for this project"
+about: "Suggest an idea for this project"
 labels: type:feature-request
 ---
 
@@ -11,22 +11,22 @@ We're happy to help you via our support channels! Please read: https://github.co
 
 By filing a feature request, you are expected to comply with our code of conduct: https://github.com/cryptomator/cryptomator/blob/develop/.github/CODE_OF_CONDUCT.md
 
-Of course we also expect you to search for existing similar feature requests, first! ;)
+Of course, we also expect you to search for existing similar feature requests first! ;)
 
 -->
 
 ### Summary
 
-One paragraph explanation of the feature.
+[One paragraph explanation of the feature.]
 
 ### Motivation
 
-Why are we doing this? What use cases does it support? What is the expected outcome?
+[Why are we doing this? What use cases does it support? What is the expected outcome?]
 
-### Describe alternatives you've considered
+### Considered Alternatives
 
-A clear and concise description of the alternative solutions you've considered. Be sure to explain why Atom's existing customizability isn't suitable for this feature.
+[A clear and concise description of the alternative solutions you've considered.]
 
-### Additional context
+### Additional Context
 
-Add any other context or screenshots about the feature request here.
+[Add any other context or screenshots about the feature request here.]