Skip to content

Commit 4e85e56

Browse files
committed
Added contributing guidelines.
1 parent 2793112 commit 4e85e56

1 file changed

Lines changed: 38 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ The following is a set of guidelines for contributing to json-graph-specificatio
1414

1515
[How Can I Contribute?](#how-can-i-contribute)
1616
* [Reporting Bugs](#reporting-bugs)
17-
17+
* [Suggesting Enhancements](#suggesting-enhancements)
18+
* [Pull Requests](#pull-requests)
1819

1920
## Code of Conduct
2021

@@ -46,4 +47,39 @@ Explain the problem and include additional details to help maintainers reproduce
4647

4748
* **Use a clear and descriptive title** for the issue to identify the problem.
4849
* **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**.
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)