Skip to content

Commit ffe766c

Browse files
authored
Merge pull request #80 from koolamusic/GithubTemplates
Github Project Templates for PULL REQUESTS, CONTRIBUTING AND CREATING ISSUES
2 parents 0d3fa9f + 0659bce commit ffe766c

File tree

5 files changed

+267
-0
lines changed

5 files changed

+267
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# REACT PROTO CODE OF CONDUCT 1.0
2+
3+
### Introduction
4+
5+
>Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open
6+
source project. In return, we ensure to reciprocate that respect in addressing your issue, assessing changes, and helping you
7+
finalize your pull requests. If you are new here also checkout our [Contribution Guidelines](CONTRIBUTING.md)
8+
9+
### Our Pledge
10+
11+
In the interest of fostering an open and welcoming environment, we as
12+
contributors and maintainers pledge to making participation in our project and
13+
our community a harassment-free experience for everyone, regardless of age, body
14+
size, disability, ethnicity, gender identity and expression, level of experience,
15+
nationality, personal appearance, race, religion, or sexual identity and
16+
orientation.
17+
18+
### Our Standards
19+
20+
Examples of behavior that contributes to creating a positive environment
21+
include:
22+
23+
* Using welcoming and inclusive language
24+
* Being respectful of differing viewpoints and experiences
25+
* Gracefully accepting constructive criticism
26+
* Focusing on what is best for the community
27+
* Showing empathy towards other community members
28+
29+
Examples of unacceptable behavior by participants include:
30+
31+
* The use of sexualized language or imagery and unwelcome sexual attention or
32+
advances
33+
* Trolling, insulting/derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or electronic
36+
address, without explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
### Our Responsibilities
41+
42+
Project maintainers are responsible for clarifying the standards of acceptable
43+
behavior and are expected to take appropriate and fair corrective action in
44+
response to any instances of unacceptable behavior.
45+
46+
Project maintainers have the right and responsibility to remove, edit, or
47+
reject comments, commits, code, wiki edits, issues, and other contributions
48+
that are not aligned to this Code of Conduct, or to ban temporarily or
49+
permanently any contributor for other behaviors that they deem inappropriate,
50+
threatening, offensive, or harmful.
51+
52+
### Scope
53+
54+
This Code of Conduct applies both within project spaces and in public spaces
55+
when an individual is representing the project or its community. Examples of
56+
representing a project or community include using an official project e-mail
57+
address, posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event. Representation of a project may be
59+
further defined and clarified by project maintainers.
60+
61+
### Enforcement
62+
63+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
64+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
65+
complaints will be reviewed and investigated and will result in a response that
66+
is deemed necessary and appropriate to the circumstances. The project team is
67+
obligated to maintain confidentiality with regard to the reporter of an incident.
68+
Further details of specific enforcement policies may be posted separately.
69+
70+
Project maintainers who do not follow or enforce the Code of Conduct in good
71+
faith may face temporary or permanent repercussions as determined by other
72+
members of the project's leadership.
73+
74+
### Attribution
75+
76+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
77+
available at [http://contributor-covenant.org/version/1/4][version]
78+
79+
[homepage]: http://contributor-covenant.org
80+
[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# React-Proto Contributing Guide 1.0
2+
3+
> First off, thank you for considering making a contribution to [React Proto](https://github.com/React-Proto/react-proto).
4+
It's people like you that inspire our commitment to open-source.
5+
6+
The goal of this document is to create a contribution process that:
7+
8+
* Encourages new contributions.
9+
* Encourages contributors to remain involved.
10+
* Creates a transparent decision making process that makes it clear how contributors can be involved in decision making.
11+
12+
## Vocabulary
13+
14+
* A **Contributor** is any individual creating or commenting on an issue or pull request.
15+
* A **Committer** is a subset of contributors who have been given write access to the repository.
16+
17+
# Logging Issues
18+
19+
Log an issue for any question or problem you might have. When in doubt, log an issue, and
20+
any additional policies about what to include will be provided in the responses. The only
21+
exception is security dislosures which should be sent privately.
22+
23+
Committers may direct you to another repository, ask for additional clarifications, and
24+
add appropriate metadata before the issue is addressed.
25+
26+
Please be courteous and respectful. Every participant is expected to follow the
27+
project's Code of Conduct.
28+
29+
Keep an open mind! Improving documentation, bug triaging, or writing tutorials are all examples of helpful contributions that
30+
mean less work for you.
31+
32+
# Contributions
33+
34+
### Ground Rules
35+
36+
> Responsibilities
37+
> * Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux.
38+
> * Ensure that code that goes into core meets all requirements and pass tests.
39+
> * Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community
40+
feedback.
41+
> * Keep feature versions as small as possible, preferably one new feature per version.
42+
> * Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. Check our [CODE OF
43+
CONDUCT](CODE_OF_CONDUCT.md)
44+
45+
46+
47+
48+
49+
Any change to resources in this repository must be through pull requests. This applies to all changes
50+
to documentation, code, binary files, etc. Even long term committers and Project Maintainers must use
51+
pull requests.
52+
53+
No pull request can be merged without being reviewed.
54+
55+
For non-trivial contributions, pull requests should sit for at least 36 hours to ensure that
56+
contributors in other timezones have time to review. Consideration should also be given to
57+
weekends and other holiday periods to ensure active committers all have reasonable time to
58+
become involved in the discussion and review process if they wish.
59+
60+
The default for each contribution is that it is accepted once no committer has an objection.
61+
During review committers may also request that a specific contributor who is most versed in a
62+
particular area gives a "LGTM" before the PR can be merged. There is no additional "sign off"
63+
process for contributions to land. Once all issues brought by committers are addressed it can
64+
be landed by any committer.
65+
66+
In the case of an objection being raised in a pull request by another committer, all involved
67+
committers should seek to arrive at a consensus by way of addressing concerns being expressed
68+
by discussion, compromise on the proposed change, or withdrawal of the proposed change.
69+
70+
If a contribution is controversial and committers cannot agree about how to get it to land
71+
or if it should land then it should be escalated to any of the Project Maintainers,
72+
[@refinedblessing](https://github.com/refinedblessing) , [@erikguntner](https://github.com/erikguntner) ,
73+
[brianwtaylor](https://github.com/brianwtaylor).
74+
Project Maintainers should regularly discuss pending contributions in order to find a resolution. It is expected that only a
75+
small minority of issues be brought to the Project Maintainers for resolution and that discussion and compromise among
76+
committers be the default resolution mechanism.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: "\U0001F41BBug report"
3+
about: Something isn't working right
4+
---
5+
6+
### React-Prot Version: x.x.x
7+
8+
<!--- Provide the exact version of React-Proto in which you see the bug. -->
9+
10+
### Details
11+
12+
<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug. How has this bug affected
13+
you? What were you trying to accomplish? -->
14+
15+
### Expected Behavior
16+
17+
<!--- Tell us what should happen -->
18+
19+
### Actual Behavior
20+
21+
<!--- Tell us what happens instead -->
22+
23+
### Possible Fix
24+
25+
<!--- Not obligatory, but suggest a fix or reason for the bug -->
26+
27+
<details><summary>Additional Info</summary>
28+
29+
### Your Environment
30+
31+
<!-- Include as many relevant details about the environment you experienced the bug in -->
32+
33+
- Environment name and version (e.g. Windows 10, node.js 5.4):
34+
- Operating System and version (Mac or Linux):
35+
- Useful link to screenshot or any other information:
36+
37+
### Steps to Reproduce
38+
39+
<!-- or an unambiguous set of steps to reproduce this bug -->
40+
41+
<!-- include code to reproduce, if relevant -->
42+
43+
1. first...
44+
2.
45+
3.
46+
4.
47+
48+
### Stack Trace
49+
50+
<!-- If an error is thrown, provide the stack trace here -->
51+
52+
</details>
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: "\U0001F680Feature request"
3+
about: Suggest an idea for React-Proto
4+
---
5+
6+
### Description
7+
8+
<!--- Provide a detailed description of the change or addition you are proposing -->
9+
10+
### Why
11+
12+
<!--- Why is this change important to you? How would you use it? -->
13+
14+
<!--- How can it benefit other users? -->
15+
16+
### Possible Implementation & Open Questions
17+
18+
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
19+
20+
<!--- What still needs to be discussed -->
21+
22+
### Is this something you're interested in working on?
23+
24+
<!--- Yes or no -->
25+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
5+
<!--- Describe your changes in detail -->
6+
7+
<!--- Why is this change required? What problem does it solve? -->
8+
9+
<!--- If it fixes an open issue, please link to the issue here. -->
10+
11+
## How Has This Been Tested?
12+
13+
<!--- Please describe in detail how you tested your changes. -->
14+
15+
<!--- Include details of your testing environment, tests ran to see how -->
16+
17+
## Types of changes
18+
19+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
20+
21+
- [ ] Bug fix (non-breaking change which fixes an issue)
22+
- [ ] New feature (non-breaking change which adds functionality)
23+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
24+
- [ ] This change requires a documentation update
25+
26+
## Checklist:
27+
28+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
29+
30+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
31+
32+
- [ ] I have read the **CONTRIBUTING** document and have signed (or will sign) the CLA.
33+
- [ ] I have updated/added documentation affected by my changes.
34+
- [ ] I have added tests to cover my changes.

0 commit comments

Comments
 (0)