From e03f1956e1fb0773acbcb861127c7011509330ba Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Mon, 13 Apr 2015 17:32:07 +1000 Subject: [PATCH] Adding CONTRIBUTING file to help guide new contributions. GitHub highlights the CONTRIBUTING file when people send pull requests or open issues, see https://github.com/blog/1184-contributing-guidelines This file includes a start of guidelines for sending patches. Fixes issue #7 - https://github.com/m-labs/misoc/issues/7 --- CONTRIBUTING.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..7cb4b0e8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,74 @@ + +# Sending Patches + +MiSoC does **not** use GitHub pull requests. Instead you must send patches to +the public mailing list . + +Before sending patches, please read the rest of this guide and make sure your +patch meets the following criteria; + + - [ ] Meets style guide requirements listed below. + - [ ] Includes a suitable commit message. + +Sending mail to the mailing list can be done via the `git send-email` tool. +The `git send-email` tool is not included by default on many Linux +distributions, on Ubuntu / Debian systems you may need to install the +`git-email` package. Documentation on using this tool can be found at +http://git-scm.com/docs/git-send-email + +To send patches to the mailing list you must first be subscribed to the list. +You can subscribe at https://ssl.serverraum.org/lists/listinfo/devel + +An example session would be; +``` +# Set up [sendemail] as described at http://git-scm.com/docs/git-send-email in +# the EXAMPLE section. + +# Download, make changes to misoc and commit them +git clone https://github.com/m-labs/misoc +cd misoc +edit xxx.py +git commit -a + +# Send patch to mailing list +# -------------------------- +# 1) Remove any previous outgoing patch +rm -rf outgoing + +# 2) Put the patches to be sent into the outgoing directory +git format-patch --cover-letter -M origin/master -o outgoing/ + +# 3) Edit the cover letter with information about the patch +edit outgoing/0000-* + +# 4) Actually send the email. +git send-email --to=devel@lists.m-labs.hk outgoing/* +``` + +# Help + +If your submission is large and complex and/or you are not sure how to proceed, +feel free to discuss it on the mailing list or IRC (#m-labs on Freenode) +beforehand. + +# Style Guide + +All new code should be complaint with the +[PEP8 style guide](https://www.python.org/dev/peps/pep-0008/). + +You can use the [pep8 tool](https://www.python.org/dev/peps/pep-0008/) to check +compliance with `pep8 myfile.py` + +When modifying existing code **be consistent** with any existing code style. +Older code is not yet PEP8 but will hopefully be converted in the future. + +# migen vs misoc vs "FPGA cores" + +FIXME: Add something like ["Puppet Core vs Modules"]( +https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md#puppet-core-vs-modules). + +# License + +All new contributions should be under the same license as MiSoC. This is a very +permissive two-clause BSD license. Full license text can be found at +https://github.com/m-labs/misoc/blob/master/LICENSE -- 2.30.2