This repository has been archived by the owner on Jun 19, 2018. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add .github contribution and template files (#38)
- Loading branch information
Showing
5 changed files
with
257 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# 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, | ||
education, socio-economic status, 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 pwa@magento.com. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
# Contributing | ||
|
||
Thank you for your interest in contributing to the peregrine project! Before you start contributing, please take a moment to read through the following guidelines: | ||
|
||
* [Code of Conduct] | ||
* [Support] | ||
|
||
To contribute to this repository, start by forking the [official repository] and following the installation instructions in the README file. | ||
|
||
## Pull Request checklist | ||
|
||
* PR commits should contain [meaningful commit messages] | ||
* To help with reviews, your PR should only create/revise a single feature or fix a single issue. | ||
* If your PR fixes a bug, please provide a step-by-step description of how to reproduce the bug. | ||
* If your PR addresses an existing issue, please reference that issue in the title or description. | ||
|
||
## Contribution process | ||
|
||
Magento maintains a public roadmap for this and other [Magento Research] repositories in each project's issue board. | ||
|
||
Any and all community participation in this backlog is encouraged and appreciated. | ||
Even foundational infrastructure stories are available for a generous developer to take on. | ||
|
||
To get started, look for issues tagged with the **[help wanted]** labels. | ||
These issues are ready for community ownership. | ||
|
||
**Note:** | ||
*We also accept unsolicited new issues/features and pull request, but priority is given to issues in our roadmap that community developers have been kind enough to take on.* | ||
|
||
### Claiming an issue on the roadmap | ||
|
||
If you are interested in taking ownership of a roadmap feature or issue, we ask that you go through the following process. | ||
This helps us organize and forecast the progress of our projects. | ||
|
||
#### Step 1: Add an issue comment | ||
|
||
Add a comment on an issue expressing your interest in taking ownership of it. | ||
Make sure your GitHub profile includes an email address so we can contact you privately. | ||
|
||
#### Step 2: Meet with a maintainer | ||
|
||
A maintainer will contact you and ask to set up a real-time meeting to discuss the issue you are interested in owning. | ||
This meeting can be in person, video chat, audio chat, or text chat. | ||
|
||
In general this meeting is brief but can vary with the complexity of an issue. | ||
For larger issues, we may schedule follow-up meetings. | ||
|
||
During this meeting, we provide you with any additional materials or resources you need to work on the issue. | ||
|
||
#### Step 3: Provide an estimate | ||
|
||
We ask that you provide us an estimate of how long it will take you to complete the issue. | ||
|
||
If you require more time to provide a time frame for completion, you are allowed to take up to five business days to think about it. | ||
|
||
If you can't get back to us by that time, we understand! | ||
As a community developer, you are helping us out in addition to your regular job. | ||
We will un-assign you from this issue, but please feel free to contribute to another issue. | ||
|
||
#### Step 4: Work on the issue | ||
|
||
After you provide an estimate, the issue is now "in progress", and | ||
you officially become a member of the [Magento Research] organization. | ||
|
||
If you need more time to work on the issue, please contact us as soon as possible. | ||
We may request an update on your progress, but we are willing to accomodate. | ||
|
||
If the deadline you provided to us passes and we have not heard from you, we will wait one week before un-assigning you from the issue. | ||
|
||
#### Step 5: Create a pull request | ||
|
||
When you finish working on an issue, create a pull request with the issue number included in the title or body. | ||
This starts the (brief) code review process. | ||
|
||
After we accept and merge your contribution, you become an official contributor! | ||
Official contributors are invited to our backlog grooming sessions and have direct influence over the product roadmap. | ||
|
||
We hope this guide paints a clear picture of your duties and expectations in the contribution process. Thank you in advance for helping with our research projects! | ||
|
||
## Report an issue | ||
|
||
Create a [GitHub issue] and put an **X** in the appropriate box to report an issue with the project. | ||
Provide as much detail as you can in each section to help us triage and process the issue. | ||
|
||
### Issue types | ||
|
||
* Bug - An error, flaw, or failure in the code | ||
* Feature suggestion - A missing feature you would like to see implemented in the project | ||
* Other - Any other type of task related to the project | ||
|
||
**Note:** | ||
*Please avoid creating GitHub issues asking for help on bugs in your project that are outside the scope of this project.* | ||
|
||
[Code of Conduct]: CODE_OF_CONDUCT.md | ||
[Support]: SUPPORT.md | ||
[official repository]: https://github.com/magento-research/peregrine | ||
[meaningful commit messages]: https://chris.beams.io/posts/git-commit/ | ||
[GitHub issue]: https://github.com/magento-research/peregrine/issues/new | ||
[Magento Research]: https://github.com/magento-research | ||
[help wanted]: https://github.com/magento-research/peregrine/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
<!-- (REQUIRED) What is the nature of this issue? --> | ||
## This issue is a: | ||
[ ] Bug | ||
[ ] Feature suggestion | ||
[ ] Other | ||
|
||
<!-- (REQUIRED) What is the issue/current behavior? --> | ||
## Description: | ||
|
||
<!-- (OPTIONAL) What needs to be done to replicate this issue? (provide Gist if needed) --> | ||
### Environment and steps to reproduce | ||
|
||
OS: | ||
|
||
Magento 2 version: | ||
|
||
Other environment information: | ||
|
||
Steps to reproduce: | ||
|
||
1. First Step | ||
2. Second Step | ||
3. Etc. | ||
|
||
<!-- (REQUIRED) When this issue is resolved, what is the expected result/behavior? --> | ||
## Expected result: | ||
|
||
<!-- (OPTIONAL) What would a solution for this issue look like? --> | ||
## Possible solutions: | ||
|
||
<!-- (OPTIONAL) What other information can you provide about this issue? --> | ||
## Additional information: | ||
|
||
<!-- | ||
Thank you for taking the time to report this issue! | ||
GitHub Issues should only be created for problems/topics related to this project's codebase. | ||
Before submitting this issue, please make sure you are complying with our Code of Conduct: | ||
https://github.com/magento-research/peregrine/blob/develop/.github/CODE_OF_CONDUCT.md | ||
Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion. | ||
Feel free to remove this section before creating this issue. | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<!-- (REQUIRED) What is the nature of this PR? --> | ||
## This PR is a: | ||
[ ] New feature | ||
[ ] Enhancement/Optimization | ||
[ ] Refactor | ||
[ ] Bugfix | ||
[ ] Test for existing code | ||
[ ] Documentation | ||
|
||
<!-- (REQUIRED) What does this PR change? --> | ||
## Summary | ||
|
||
When this pull request is merged, it will... | ||
|
||
<!-- (OPTIONAL) What other information can you provide about this PR? --> | ||
## Additional information | ||
|
||
<!-- | ||
Thank you for your contribution! | ||
Before submitting this pull request, please make sure you have read our Contribution Guidelines and your PR meets our contribution standards: | ||
https://github.com/magento-research/peregrine/blob/develop/.github/CONTRIBUTION.md | ||
Please fill out as much information as you can about your PR to help speed up the review process. | ||
If your PR addresses an existing GitHub Issue, please refer to it in the title or Additional Information section to make the connection. | ||
We may ask you for changes in your PR in order to meet the standards set in our Contribution Guidelines. PR's that do not comply with our guidelines may be closed at the maintainers' discretion. | ||
Feel free to remove this section before creating this PR. | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Support | ||
|
||
Need help with something? Please use the following resources to get the help you need: | ||
|
||
* Documentation website - [PWA DevDocs] | ||
* Chat with us on **Slack** - [#pwa channel] | ||
* Send us an Email: pwa@magento.com | ||
|
||
[PWA DevDocs]: https://magento-research.github.io/pwa-devdocs/ | ||
[#pwa channel]: https://magentocommeng.slack.com/messages/C71HNKYS2 |