Skip to content

Commit 0b97829

Browse files
author
whitequark
committed
Change CONTRIBUTING to use ReST syntax and rename back.
1 parent beef2a4 commit 0b97829

File tree

2 files changed

+37
-34
lines changed

2 files changed

+37
-34
lines changed

CONTRIBUTING.md

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

CONTRIBUTING.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Sending Patches
2+
===============
3+
4+
Patches for MiSoC may be sent via GitHub pull requests. Alternatively, if
5+
you prefer using mailing lists, they can also be sent to
6+
the `public mailing list <mailto:[email protected]>`_ after
7+
`subscribing <https://ssl.serverraum.org/lists/listinfo/devel>`_.
8+
9+
Before sending patches, please read the rest of this guide and make sure your
10+
patch meets the following criteria;
11+
12+
* Meets style guide requirements listed below.
13+
* Includes a suitable commit message.
14+
15+
Help
16+
----
17+
18+
If your submission is large and complex and/or you are not sure how to proceed,
19+
feel free to discuss it on the mailing list or IRC (#m-labs on Freenode)
20+
beforehand.
21+
22+
Style Guide
23+
-----------
24+
25+
All code should be compliant with the
26+
`PEP8 style guide <https://www.python.org/dev/peps/pep-0008/>`_.
27+
28+
You can use the `pep8 tool <https://www.python.org/dev/peps/pep-0008/>`_ to check
29+
compliance with ``pep8 myfile.py``.
30+
31+
When modifying existing code **be consistent** with any existing code style.
32+
33+
License
34+
=======
35+
36+
All new contributions should be under the same license as MiSoC. This is a very
37+
permissive two-clause BSD license; see `full license text <LICENSE>`_.

0 commit comments

Comments
 (0)