|
| 1 | +============================ |
| 2 | +Contributing to `jsonschema` |
| 3 | +============================ |
| 4 | + |
| 5 | +Found a bug? |
| 6 | +------------ |
| 7 | + |
| 8 | +If you suspect you may have found a security-related vulnerability, please follow the instructions in `the security policy <https://github.com/python-jsonschema/jsonschema/blob/main/.github/SECURITY.md>`_. |
| 9 | + |
| 10 | +Otherwise, it is extremely helpful if you first search to see whether your bug has been `previously reported on the Issues tab <https://github.com/python-jsonschema/jsonschema/issues?q=is%3Aissue+is%3Aopen+label%3ABug>`_. |
| 11 | + |
| 12 | +If it doesn't appear to be a known issue, please `file a new one <https://github.com/python-jsonschema/jsonschema/issues/new>`_, and include a **title and clear description**, along with as much relevant information as possible. |
| 13 | +Including a *minimal*, *self-sufficient* bit of code (often an instance and schema) is the fastest way to get attention, along with a description of the behavior you expect, and if you're able, a link to where in the specification contains the behavior you're noticing is incorrect. |
| 14 | + |
| 15 | +Pull requests to fix your issue are of course very welcome. |
| 16 | + |
| 17 | + |
| 18 | +Fixing a Bug? |
| 19 | +------------- |
| 20 | + |
| 21 | +Please open a new GitHub pull request with the change, along with new tests. |
| 22 | + |
| 23 | +Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. |
| 24 | + |
| 25 | +Continuous integration via GitHub actions should run to indicate whether your change passes both the test suite as well as linters. |
| 26 | +Please ensure it passes, or indicate in a comment if you believe it fails spuriously. |
| 27 | + |
| 28 | + |
| 29 | +Adding New Functionality? |
| 30 | +------------------------- |
| 31 | + |
| 32 | +Please discuss any larger changes ahead of time for the sake of your own time! |
| 33 | + |
| 34 | +Improvements are very welcome, but large pull requests, disruptive ones, or backwards incompatible ones, can lead to long back and forth discussions. |
| 35 | + |
| 36 | +You're welcome to suggest a change in an issue and thereby get some initial feedback before embarking on an effort that may not get merged. |
| 37 | + |
| 38 | + |
| 39 | +Improving the Documentation? |
| 40 | +---------------------------- |
| 41 | + |
| 42 | +Writing good documentation is challenging both to prioritize and to do well. |
| 43 | + |
| 44 | +Any help you may have would be great, especially if you're a beginner who's struggled to understand a part of the library. |
| 45 | + |
| 46 | +Documentation is written in `Sphinx-flavored reStructuredText <https://www.sphinx-doc.org>`_, so you'll want to familiarize yourself a bit with Sphinx. |
| 47 | + |
| 48 | +Feel free to file issues or pull requests. |
| 49 | + |
| 50 | + |
| 51 | +Have a Question? |
| 52 | +---------------- |
| 53 | + |
| 54 | +Please do not use the issue tracker for questions, it's reserved for things believed to be bugs, or new functionality. |
| 55 | + |
| 56 | +There is a `discussions tab <https://github.com/python-jsonschema/jsonschema/discussions>`_ where general questions can be asked. |
| 57 | + |
| 58 | +Answers on it are best-effort. |
| 59 | + |
| 60 | +Any help you can offer to answer others' questions is of course very welcome as well. |
0 commit comments