Skip to content

Commit beef2a4

Browse files
author
whitequark
authored
Update CONTRIBUTING.
- Mention that we accept patches via GitHub, but keep the mailing list address for the few people who prefer those. - Remove git send-email instructions; those who want to send patches via email already know how to do it, and the rest will just get confused. - Rename to CONTRIBUTING.md because this file already contained only Markdown markup.
1 parent 2436a68 commit beef2a4

File tree

2 files changed

+34
-68
lines changed

2 files changed

+34
-68
lines changed

CONTRIBUTING.md

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

CONTRIBUTING.rst

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

0 commit comments

Comments
 (0)