mirror of
https://github.com/cedricbonhomme/Stegano.git
synced 2025-05-13 01:18:31 +02:00
Fix titles in CONTRIBUTING.rst
This commit is contained in:
parent
966b4921d1
commit
a65bce640f
1 changed files with 10 additions and 6 deletions
|
@ -1,9 +1,11 @@
|
||||||
# Contribution Guidelines
|
Contribution Guidelines
|
||||||
|
=======================
|
||||||
|
|
||||||
Before opening proposing any pull requests (about code or documentation),
|
Before opening proposing any pull requests (about code or documentation),
|
||||||
please open an issue.
|
please open an issue.
|
||||||
|
|
||||||
## Code Contributions
|
Code Contributions
|
||||||
|
------------------
|
||||||
|
|
||||||
When contributing code, you'll want to follow this checklist:
|
When contributing code, you'll want to follow this checklist:
|
||||||
|
|
||||||
|
@ -20,7 +22,8 @@ When contributing code, you'll want to follow this checklist:
|
||||||
GitHub Pull Requests are the expected method of code collaboration on this
|
GitHub Pull Requests are the expected method of code collaboration on this
|
||||||
project.
|
project.
|
||||||
|
|
||||||
### Code Style
|
Code Style
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
Please try to respect the `PEP 8`_ code style.
|
Please try to respect the `PEP 8`_ code style.
|
||||||
|
|
||||||
|
@ -31,7 +34,8 @@ following additional notes.
|
||||||
.. _PEP 8: http://pep8.org
|
.. _PEP 8: http://pep8.org
|
||||||
|
|
||||||
|
|
||||||
## Documentation Contributions
|
Documentation Contributions
|
||||||
|
---------------------------
|
||||||
|
|
||||||
Documentation improvements are always welcome! The documentation files live in
|
Documentation improvements are always welcome! The documentation files live in
|
||||||
the ``docs/`` directory of the codebase. They're written in
|
the ``docs/`` directory of the codebase. They're written in
|
||||||
|
@ -50,8 +54,8 @@ When presenting Python code, use single-quoted strings (``'hello'`` instead of
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Questions
|
||||||
# Questions
|
=========
|
||||||
|
|
||||||
The GitHub issue tracker is for *bug reports* and *feature requests*. Please do
|
The GitHub issue tracker is for *bug reports* and *feature requests*. Please do
|
||||||
not use it to ask questions about how to use Stegano. These questions should
|
not use it to ask questions about how to use Stegano. These questions should
|
||||||
|
|
Loading…
Add table
Reference in a new issue