diff options
author | Tobias Weimer <wishmaster51@gmail.com> | 2018-06-10 10:27:18 +0200 |
---|---|---|
committer | George Hazan <ghazan@miranda.im> | 2018-06-15 12:29:26 +0300 |
commit | 58a1e4b5472db9f0b8a0c9ee2bd0cf98de5da841 (patch) | |
tree | f54979b62d3834f207c84a809ef896eb5c702bc7 /.github | |
parent | b0c120d39b13cde7b52a16d0343d8d38c1ce489e (diff) |
Restructured guthub pages, added issue templates
Diffstat (limited to '.github')
-rw-r--r-- | .github/CODE_OF_CONDUCT.md | 46 | ||||
-rw-r--r-- | .github/CONTRIBUTING.md | 31 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 20 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 18 |
4 files changed, 115 insertions, 0 deletions
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..a9603dd8e2 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +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. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, 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. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at info@miranda-ng.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other 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] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..acfb03691e --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,31 @@ +## Before reporting a bug +* Update to the latest *development version* (**caution:** Use a clean profile or make a backup of your working profile. It may not be possible to downgrade without data loss!). +* Check if the problem persists (it may happen that it has been fixed). +* Search the *issues* for an existing bug report for your problem. + +## Effective bug reporting +Using the following tips will **greatly** increase the chances of your issue being '''noticed''' and '''fixed''' quickly. + +* Have a well-written bug **Summary** field – describe the issue clearly, in simple words. +* **Description** field – provide step-by-step instructions so we can reproduce the issue (*We can't fix what we can't reproduce*). +* Attach screenshots if possible. +* Attach your [VersionInfo](https://wiki.miranda-ng.org/index.php?title=Version_information). +* Attach a [crash report](https://wiki.miranda-ng.org/index.php?title=Crash_reports) if you are experiencing crashes (It includes VersionInfo as well). +* Attach a [network log](https://wiki.miranda-ng.org/index.php?title=Network_log) captured if you are experiencing connectivity issues. +* If Miranda freezes, hangs up or consumes CPU, attach [information obtained by Process Explorer tool](https://wiki.miranda-ng.org/index.php?title=Using_Process_Explorer_as_the_debugging_tool). + +### How to attach files +* Attach files by dragging & dropping, selecting them, or pasting from the clipboard +* Press *Submit new issue*. + +## I know when it got broken +If you know things got broken in some version or at some particular time, then it's good because you can try different releases from different revisions and narrow down where exactly the problem started to happen. +* you can either compile the revisions yourself (that requires more knowledge and time) +* or ask someone in our [jabber conference](xmpp:miranda-ng-int@conference.jabber.ru?join) to help you identify potentially problematic revisions and then ask to compile those revisions for you. + +Then you can try to reproduce your problem on each of them and find out when exactly it got broken. With that info it's easy to reach out the developer who commited the broken commit and ask him to look at it. + +## After reporting an issue +* Monitor the issues you report. +* Provide feedback and additional information if requested. +* Don't argue about whether something is a bug or not. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..ed5ac0901b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,20 @@ +--- +name: Bug report +about: Create a report to help us improve Miranda NG. + +--- +### Expected behavior +What did you expect? + +### Actual behavior +What did you get instead? + +### Does it work in stable version? +If you know in which dev build (or approximate date when) it was broken, it may be much easier to identify and fix the issue. + +### Steps to reproduce that behavior + * Provide step-by-step instructions so we can reproduce the issue (We can't fix what we can't reproduce). + * Attach your VersionInfo. + * Attach a crash report if you are experiencing crashes (It includes VersionInfo as well). + * Attach a network log captured if you are experiencing connectivity issues. + * If Miranda freezes, hangs up or consumes CPU, attach information obtained by Process Explorer tool. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..20199918a3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request +about: Suggest an idea for Miranda NG. + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. + |