Skip to content

Commit 366e18c

Browse files
authored
Merge pull request #31 from ArSn/contributing
Adding code of conduct and contributing guidelines
2 parents 2a4da30 + f232220 commit 366e18c

2 files changed

Lines changed: 129 additions & 0 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, 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. When such action is taken, an explanatory statement should be added by the maintainer for both, the sake of informing the contributor about their wrongdoing and as an educational point for the community.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. 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.
38+
39+
## Attribution
40+
41+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
42+
43+
[homepage]: https://contributor-covenant.org
44+
[version]: https://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Contributing to json-graph-specification
2+
3+
First off, thanks for taking the time to contribute!
4+
5+
The following is a set of guidelines for contributing to json-graph-specification, which are hosted in the [JSON Graph Organization](https://github.com/jsongraph) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
6+
7+
#### Table Of Contents
8+
9+
[Code of Conduct](#code-of-conduct)
10+
11+
[I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
12+
13+
[What should I know before I get started?](#what-should-i-know-before-i-get-started)
14+
15+
[How Can I Contribute?](#how-can-i-contribute)
16+
* [Reporting Bugs](#reporting-bugs)
17+
* [Suggesting Enhancements](#suggesting-enhancements)
18+
* [Pull Requests](#pull-requests)
19+
20+
## Code of Conduct
21+
22+
This project and everyone participating in it is governed by the [JSON Graph Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior.
23+
24+
## I don't want to read this whole thing I just have a question!!!
25+
26+
Feel free to [open an issue](https://github.com/jsongraph/json-graph-specification/issues/new) at any time.
27+
28+
## What should I know before I get started?
29+
30+
Before opening issues about topics that are already solved, please read the [readme file](https://github.com/jsongraph/json-graph-specification#readme) that is describing what this project is about and how it works. Also, have a look at the [project page](http://jsongraphformat.info/).
31+
32+
## How Can I Contribute?
33+
34+
### Reporting Bugs
35+
36+
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
37+
38+
Before creating bug reports, please check [the open issues](https://github.com/jsongraph/json-graph-specification/issues) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report).
39+
40+
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
41+
42+
#### How Do I Submit A (Good) Bug Report?
43+
44+
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). If at all possible, please provide a [Short, Self Contained, Correct (Compilable), Example](http://sscce.org/).
45+
46+
Explain the problem and include additional details to help maintainers reproduce the problem:
47+
48+
* **Use a clear and descriptive title** for the issue to identify the problem.
49+
* **Describe the exact steps which reproduce the problem** in as many details as possible. When listing steps, **don't just say what you did, but explain how you did it**.
50+
* **Provide specific examples to demonstrate the steps**.
51+
52+
Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
53+
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
54+
* **Explain which behavior you expected to see instead and why.**
55+
56+
### Suggesting Enhancements
57+
58+
This section guides you through submitting an enhancement suggestion for json-graph-specification, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
59+
60+
When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion).
61+
62+
#### How Do I Submit A (Good) Enhancement Suggestion?
63+
64+
Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue and provide the following information:
65+
66+
* **Use a clear and descriptive title** for the issue to identify the suggestion.
67+
* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
68+
* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
69+
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
70+
71+
### Pull Requests
72+
73+
This is the main way how you can contribute to the specification. Feel free to open a pull request for your propsed changes at any time. The requirements described here have several goals:
74+
75+
- Maintain the quality of json-graph-specification
76+
- Fix problems that are important to users
77+
- Engage the community in working toward the best possible json-graph-specification
78+
79+
Please adhere to these requirements to have your contribution considered by the maintainers:
80+
81+
1. Write meaningful commit messages
82+
2. Explain in your pull request what you are trying to achieve, and why
83+
3. Be open minded about suggestions or other perspectives from the maintainers and other contributors
84+
85+
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

0 commit comments

Comments
 (0)