Skip to content

Commit 2aa31c4

Browse files
committed
docs: Use md for CONTRIBUTING
1 parent a05b246 commit 2aa31c4

File tree

3 files changed

+47
-50
lines changed

3 files changed

+47
-50
lines changed

.pre-commit-config.yaml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,3 @@ repos:
5858
- id: mypy
5959
exclude: ^(docs/|test/).*$
6060
args: ["--ignore-missing-imports"]
61-
62-
- repo: https://github.com/myint/rstcheck
63-
rev: v6.1.2
64-
hooks:
65-
- id: rstcheck
66-
additional_dependencies:
67-
- sphinx==4.5.0

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing to hypothesis-graphql
2+
3+
Welcome! I am happy that you are here :)
4+
5+
## Report bugs
6+
7+
Report bugs for Hypothesis-GraphQL in the [issue tracker](https://github.com/Stranger6667/hypothesis-graphql/issues).
8+
9+
If you are reporting a bug, please:
10+
11+
- Write a simple and descriptive title to identify the problem.
12+
- Describe the exact steps which reproduce the problem in as many
13+
details as possible.
14+
- Describe the behavior you observed after following the steps and
15+
point out what exactly is the problem with that behavior.
16+
- Explain which behavior you expected to see instead and why.
17+
- Include Python / Hypothesis-GraphQL versions.
18+
19+
It would be awesome if you can submit a failing test that demonstrates
20+
the problem.
21+
22+
## Submitting Pull Requests
23+
24+
1. Fork the repository.
25+
26+
2. Enable and install [pre-commit](https://pre-commit.com) to ensure style-guides and code checks are followed.
27+
28+
3. Target the `master` branch.
29+
30+
4. Follow **PEP-8** for naming and [black](https://github.com/psf/black) for formatting.
31+
32+
5. Tests are run using `tox`:
33+
34+
tox -e py37
35+
36+
The test environment above is usually enough to cover most cases
37+
locally.
38+
39+
For each pull request, we aim to review it as soon as possible. If you
40+
wait a few days without a reply, please feel free to ping the thread by
41+
adding a new comment.
42+
43+
At present the core developers are:
44+
45+
- Dmitry Dygalo [@Stranger6667](https://github.com/Stranger6667)
46+
47+
Thanks!

CONTRIBUTING.rst

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)