From: Sebastien Bourdeauducq Date: Tue, 22 Sep 2015 16:57:36 +0000 (+0800) Subject: CONTRIBUTING.md->rst X-Git-Tag: 24jan2021_ls180~2106^2~51 X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=74b3e16dd02fb44d5455d1d6246edcebc58d1fc3;p=litex.git CONTRIBUTING.md->rst --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 72bbdfa7..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,68 +0,0 @@ - -# 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 code should be compliant 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. - -# 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 diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..72bbdfa7 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,68 @@ + +# 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 code should be compliant 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. + +# 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 diff --git a/README b/README index 84201034..468fbef6 100644 --- a/README +++ b/README @@ -106,7 +106,7 @@ modules. 9. Contribute a patch! Once you have experimented with stuff, please send your results back. - For more details on how to do so, you can see the CONTRIBUTING.md file. + For more details on how to do so, you can see the CONTRIBUTING.rst file. [> License ----------