Skip to content

Latest commit

 

History

History
87 lines (51 loc) · 5.59 KB

CONTRIBUTING.md

File metadata and controls

87 lines (51 loc) · 5.59 KB
Raw

Contributing to json-graph-specification

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to json-graph-specification, which are hosted in the JSON Graph Organization 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.

Table Of Contents

Code of Conduct

I don't want to read this whole thing, I just have a question!!!

What should I know before I get started?

How Can I Contribute?

Code of Conduct

This project and everyone participating in it is governed by the JSON Graph Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior.

I don't want to read this whole thing I just have a question!!!

Feel free to open an issue at any time.

What should I know before I get started?

Before opening issues about topics that are already solved, please read the readme file that is describing what this project is about and how it works. Also, have a look at the project page.

How Can I Contribute?

Reporting Bugs

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.

Before creating bug reports, please check the open 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.

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.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. If at all possible, please provide a Short, Self Contained, Correct (Compilable), Example.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • 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.
  • Provide specific examples to demonstrate the steps.

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.

  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.

Suggesting Enhancements

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.

When you are creating an enhancement suggestion, please include as many details as possible.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.

Pull Requests

This is the main way how you can contribute to the specification. Feel free to open a pull request for your proposed changes at any time. It is advised to open a Github issue in the project first to get feedback from other users/maintainers before opening a pull request. You can then reference that issue in the Pull Request.

The requirements described here have several goals:

  • Maintain the quality of json-graph-specification
  • Fix problems that are important to users
  • Engage the community in working toward the best possible json-graph-specification

Please adhere to these requirements to have your contribution considered by the maintainers:

  1. Write meaningful commit messages
  2. Explain in your pull request what you are trying to achieve, and why
  3. Be open minded about suggestions or other perspectives from the maintainers and other contributors

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.