This repository has been archived by the owner on Jan 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
739b206
commit ea96386
Showing
5 changed files
with
175 additions
and
4 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 |
---|---|---|
@@ -1,2 +1,3 @@ | ||
/node_modules/ | ||
/example/node_modules/ | ||
/example/node_modules/ | ||
*.tgz |
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,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 [email protected]. 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/ |
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,119 @@ | ||
# Introduction | ||
|
||
### First off, thank you for considering contributing to react-json-editor-ajrm. It's people like you that make it such a great repository. | ||
|
||
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. | ||
|
||
|
||
RJEA is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into RJEA itself. | ||
|
||
### About Inquiries | ||
|
||
Until our slack channel is set up, feel free to use the [issue tracker](https://github.com/AndrewRedican/react-json-editor-ajrm/issues) for support questions. | ||
|
||
# Your First Contribution | ||
Unsure where to begin contributing to RJEA? You can start by looking through these beginner and help-wanted issues: | ||
|
||
* [Beginner issues]() - issues which should only require a few lines of code, and a test or two. | ||
* [Help wanted issues]() - issues which should be a bit more involved than beginner issues. | ||
|
||
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have. | ||
|
||
### Working on your first Pull Request? | ||
|
||
You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). | ||
|
||
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat: | ||
|
||
FYI - If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge. | ||
|
||
# Getting started | ||
|
||
As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. As long as the change does not affect functionality, some likely examples include the following: | ||
* Spelling / grammar fixes | ||
* Typo correction, white space and formatting changes | ||
* Comment clean up | ||
* Bug fixes that change default return values or error codes stored in constants | ||
* Adding logging messages or debugging output | ||
* Changes to ‘metadata’ files like Gemfile, .gitignore, build scripts, etc. | ||
* Moving source files from one directory or package to another | ||
|
||
# How to report a bug | ||
If you find a security vulnerability, do NOT open an issue. Email [email protected] instead. | ||
In order to determine whether you are dealing with a security issue, ask yourself these two questions: | ||
|
||
* Can I access something that's not mine, or something I shouldn't have access to? | ||
* Can I disable something for other people? | ||
|
||
If you don’t want to use your personal contact information, set up a “security@” email address. Larger projects might have more formal processes for disclosing security, including encrypted communication. (Disclosure: I am not a security expert.) | ||
If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, just email us at [email protected]. | ||
|
||
### When filing an issue, make sure to answer these five questions: | ||
|
||
1. What version of Go are you using (go version)? | ||
2. What operating system and processor architecture are you using? | ||
3. What did you do? | ||
4. What did you expect to see? | ||
5. What did you see instead? | ||
|
||
# How to suggest a feature or enhancement | ||
If you find yourself wishing for a feature that doesn't exist in RJEA, you are probably not alone. There are bound to be others out there with similar needs. The proper way to do it is to open up a new issue [here](https://github.com/AndrewRedican/react-json-editor-ajrm/issues). Please make sure to check the list of existing feature requests to avoid duplication. | ||
|
||
# Code review process | ||
This is the checklist that I try to go through for every single pull request that I get. If you're wondering why it takes so long for me to accept pull requests, this is why. | ||
|
||
- [ ] **General** | ||
|
||
- [ ] Is this change useful to me, or something that I think will benefit others greatly? | ||
- [ ] Check for overlap with other PRs. | ||
- [ ] Think carefully about the long-term implications of the change. How will it affect existing projects that are dependent on this? How will it affect my projects? If this is complicated, do I really want to maintain it forever? Is there any way it could be implemented as a separate package, for better modularity and flexibility? | ||
|
||
- [ ] **Check the Code** | ||
|
||
- [ ] If it does too much, ask for it to be broken up into smaller PRs. | ||
- [ ] Is it consistent? | ||
- [ ] Review the changes carefully, line by line. Make sure you understand every single part of every line. Learn whatever you do not know yet. | ||
- [ ] Take the time to get things right. PRs almost always require additional improvements to meet the bar for quality. Be very strict about quality. This usually takes several commits on top of the original PR. | ||
|
||
- [ ] **Check the Tests** | ||
|
||
- [ ] Does it have tests? If not: | ||
|
||
- [ ] Comment on the PR "Can you please add tests for this code to `foo_bar.js`", or... | ||
- [ ] Write the tests yourself. | ||
|
||
- [ ] Do the tests pass for all of the following? If not, write a note in the PR, or fix them yourself. [**Read about testing**](https://github.com/AndrewRedican/react-json-editor-ajrm/wiki/How-to-Create-and-Run-Tests) | ||
|
||
- [ ] *Outlines have not been defined yet.* | ||
|
||
- [ ] **Check the Doc** | ||
|
||
- [ ] Does it have docs? If not: | ||
|
||
- [ ] Comment on the PR "Can you please add docs for this feature to `docs/usage.rst`", or... | ||
- [ ] Write the docs yourself. | ||
|
||
- [ ] If any new functions/classes are added, do they contain docstrings? | ||
- [ ] If any new features are added, are they in `README.rst`? | ||
|
||
- [ ] **Credit the Authors** | ||
|
||
- [ ] Add name and URL to `AUTHORS.rst`. | ||
- [ ] Copy and paste title and PR number into `HISTORY.rst`. | ||
- [ ] Thank them for their hard work. | ||
|
||
- [ ] **Close Issues** | ||
|
||
- [ ] Merge the PR branch. This will close the PR's issue. | ||
- [ ] Close any duplicate or related issues that can now be closed. Write thoughtful comments explaining how the issues were resolved. | ||
|
||
- [ ] **Release** | ||
|
||
- [ ] Decide whether the changes in master make sense as a major, minor, or patch release. | ||
- [ ] Look at the clock. If you're tired, release later when you have time to deal with release problems. | ||
- [ ] Then follow all the steps in [post-release guidelines](). | ||
|
||
# Community | ||
1. Github | ||
2. Twitter | ||
3. Slack |
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,5 @@ | ||
1. What version of RJEA are you using (react-json-editor-ajrm version)? | ||
2. What operating system and processor architecture are you using? | ||
3. What did you do? | ||
4. What did you expect to see? | ||
5. What did you see instead? |
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