CONTRIBUTING.md

   1
   2 # Sending Patches
   3
   4 MiSoC does **not** use GitHub pull requests. Instead you must send patches to
   5 the public mailing list <devel@lists.m-labs.hk>.
   6
   7 Before sending patches, please read the rest of this guide and make sure your
   8 patch meets the following criteria;
   9
  10  - [ ] Meets style guide requirements listed below.
  11  - [ ] Includes a suitable commit message.
  12
  13 Sending mail to the mailing list can be done via the `git send-email` tool.
  14 The `git send-email` tool is not included by default on many Linux
  15 distributions, on Ubuntu / Debian systems you may need to install the
  16 `git-email` package. Documentation on using this tool can be found at
  17 http://git-scm.com/docs/git-send-email
  18
  19 To send patches to the mailing list you must first be subscribed to the list.
  20 You can subscribe at https://ssl.serverraum.org/lists/listinfo/devel
  21
  22 An example session would be;
  23 ```
  24 # Set up [sendemail] as described at http://git-scm.com/docs/git-send-email in
  25 # the EXAMPLE section.
  26
  27 # Download, make changes to misoc and commit them
  28 git clone https://github.com/m-labs/misoc
  29 cd misoc
  30 edit xxx.py
  31 git commit -a
  32
  33 # Send patch to mailing list
  34 # --------------------------
  35 # 1) Remove any previous outgoing patch
  36 rm -rf outgoing
  37
  38 # 2) Put the patches to be sent into the outgoing directory
  39 git format-patch --cover-letter -M origin/master -o outgoing/
  40
  41 # 3) Edit the cover letter with information about the patch
  42 edit outgoing/0000-*
  43
  44 # 4) Actually send the email.
  45 git send-email --to=devel@lists.m-labs.hk outgoing/*
  46 ```
  47
  48 # Help
  49
  50 If your submission is large and complex and/or you are not sure how to proceed,
  51 feel free to discuss it on the mailing list or IRC (#m-labs on Freenode)
  52 beforehand.
  53
  54 # Style Guide
  55
  56 All code should be compliant with the
  57 [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/).
  58
  59 You can use the [pep8 tool](https://www.python.org/dev/peps/pep-0008/) to check
  60 compliance with `pep8 myfile.py`
  61
  62 When modifying existing code **be consistent** with any existing code style.
  63
  64 # License
  65
  66 All new contributions should be under the same license as MiSoC. This is a very
  67 permissive two-clause BSD license. Full license text can be found at
  68 https://github.com/m-labs/misoc/blob/master/LICENSE