Skip to content

Commit 2793112

Browse files
committed
Added contributing guidelines.
1 parent 6ad4bab commit 2793112

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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+
18+
19+
## Code of Conduct
20+
21+
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.
22+
23+
## I don't want to read this whole thing I just have a question!!!
24+
25+
Feel free to [open an issue](https://github.com/jsongraph/json-graph-specification/issues/new) at any time.
26+
27+
## What should I know before I get started?
28+
29+
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/).
30+
31+
## How Can I Contribute?
32+
33+
### Reporting Bugs
34+
35+
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.
36+
37+
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).
38+
39+
> **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.
40+
41+
#### How Do I Submit A (Good) Bug Report?
42+
43+
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
44+
45+
Explain the problem and include additional details to help maintainers reproduce the problem:
46+
47+
* **Use a clear and descriptive title** for the issue to identify the problem.
48+
* **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**.
49+
* **Provide specific examples to demonstrate the steps**.

0 commit comments

Comments
 (0)