Skip to content

Commit

Permalink
Refactor markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
asaskevich committed Aug 18, 2020
1 parent ed08054 commit 50839af
Show file tree
Hide file tree
Showing 7 changed files with 194 additions and 2 deletions.
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/BC_Break.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: 💥 BC Break
about: Have you encountered an issue during upgrade? 💣
---

<!--
Before reporting a BC break, please consult the CHANGELOG to make sure it's not
an expected change by checking the CHANGELOG.md file in this repository.
-->

### BC Break Report

<!-- Fill in the relevant information below to help triage your issue. -->

| Q | A
|------------ | ------
| Version | x.y.z

#### Summary

<!-- Provide a summary describing the problem you are experiencing. -->

#### Previous behavior

<!-- What was the previous (working) behavior? -->

#### Current behavior

<!-- What is the current (broken) behavior? -->

#### How to reproduce

<!--
Provide steps to reproduce the BC break.
Adding a failing unit test would help us a lot - you can submit it in a Pull
Request separately, referencing this bug report.
-->
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: 🐞 Bug Report
about: Something is broken? 🔨
---

### Bug Report

<!-- Fill in the relevant information below to help triage your issue. -->

| Q | A
|------------ | ------
| Version(s) | x.y.z

#### Summary

<!-- Provide a summary describing the problem you are experiencing. -->

#### Current behavior

<!-- What is the current (buggy) behavior? -->

#### How to reproduce

<!--
Provide steps to reproduce the bug.
Adding a failing unit test would help us a lot - you can submit one in a Pull
Request separately, referencing this bug report.
-->

#### Expected behavior

<!-- What was the expected (correct) behavior? -->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_Request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 🎉 Feature Request
about: You have an idea or feature that should be implemented? 🎩
---

### Feature Request

<!-- Fill in the relevant information below to help triage your issue. -->

| Q | A
|------------ | ------
| New Feature | yes
| RFC | yes/no
| BC Break | yes/no

#### Summary

<!--
Provide a summary of the feature you would like to see implemented.
-->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: ❓ Support & Discussion
url: https://gitter.im/asaskevich/govalidator
about: 'You can leave comments and participate in the discussion via Gitter:'
55 changes: 55 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<!--
Fill in the relevant information below to help triage your issue.
Pick the target branch based on the following criteria:
* Documentation improvement: master branch
* Bugfix: master branch
* QA improvement (additional tests, CS fixes, etc.) that does not change code
behavior: master branch
* New feature, or refactor of existing code: master/develop branch
-->

| Q | A
|-------------- | ------
| Documentation | yes/no
| Bugfix | yes/no
| BC Break | yes/no
| New Feature | yes/no
| RFC | yes/no
| QA | yes/no

### Description

<!--
Tell us about why this change is necessary:
- Are you fixing a bug or providing a failing unit test to demonstrate a bug?
- How do you reproduce it?
- What did you expect to happen?
- What actually happened?
- TARGET THE master BRANCH
- Are you adding documentation?
- TARGET THE master BRANCH
- Are you providing a QA improvement (additional tests, CS fixes, etc.) that
does not change behavior?
- Explain why the changes are necessary
- TARGET THE master BRANCH
- Are you fixing a BC Break?
- How do you reproduce it?
- What was the previous behavior?
- What is the current behavior?
- TARGET THE master BRANCH
- Are you adding something the library currently does not support?
- Why should it be added?
- What will it enable?
- How will the code be used?
- TARGET THE develop BRANCH
- Are you refactoring code?
- Why do you feel the refactor is necessary?
- What types of refactoring are you doing?
- TARGET THE develop BRANCH
-->
43 changes: 43 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributor Code of Conduct

This project adheres to [The Code Manifesto](http://codemanifesto.com)
as its guidelines for contributor interactions.

## The Code Manifesto

We want to work in an ecosystem that empowers developers to reach their
potential — one that encourages growth and effective collaboration. A space
that is safe for all.

A space such as this benefits everyone that participates in it. It encourages
new developers to enter our field. It is through discussion and collaboration
that we grow, and through growth that we improve.

In the effort to create such a place, we hold to these values:

1. **Discrimination limits us.** This includes discrimination on the basis of
race, gender, sexual orientation, gender identity, age, nationality,
technology and any other arbitrary exclusion of a group of people.
2. **Boundaries honor us.** Your comfort levels are not everyone’s comfort
levels. Remember that, and if brought to your attention, heed it.
3. **We are our biggest assets.** None of us were born masters of our trade.
Each of us has been helped along the way. Return that favor, when and where
you can.
4. **We are resources for the future.** As an extension of #3, share what you
know. Make yourself a resource to help those that come after you.
5. **Respect defines us.** Treat others as you wish to be treated. Make your
discussions, criticisms and debates from a position of respectfulness. Ask
yourself, is it true? Is it necessary? Is it constructive? Anything less is
unacceptable.
6. **Reactions require grace.** Angry responses are valid, but abusive language
and vindictive actions are toxic. When something happens that offends you,
handle it assertively, but be respectful. Escalate reasonably, and try to
allow the offender an opportunity to explain themselves, and possibly
correct the issue.
7. **Opinions are just that: opinions.** Each and every one of us, due to our
background and upbringing, have varying opinions. That is perfectly
acceptable. Remember this: if you respect your own opinions, you should
respect the opinions of others.
8. **To err is human.** You might not intend it, but mistakes do happen and
contribute to build experience. Tolerate honest mistakes, and don't
hesitate to apologize if you make one yourself.

0 comments on commit 50839af

Please sign in to comment.