diff options
| -rw-r--r-- | COMMUNITY.md | 33 | ||||
| -rw-r--r-- | render_md.py | 24 |
2 files changed, 43 insertions, 14 deletions
diff --git a/COMMUNITY.md b/COMMUNITY.md index 9539c7e572..80478ceffe 100644 --- a/COMMUNITY.md +++ b/COMMUNITY.md @@ -1,10 +1,11 @@ # Developing for PROJECT (DRAFT) +[TOC] ## Git Structure The master Git for PROJECT resides on Github at -https://github.com/PROJECT/XXX +[https://github.com/PROJECT/XXX](https://github.com/PROJECT/XXX) There are 3 main branches for development and a release branch for each major release. @@ -39,14 +40,14 @@ preference on Markdown. ## Before Submitting your changes -* Format code (see Code Styling requirements) -* Verify and acknowledge license (see License for contributions) +* Format code (see [Code Styling requirements](#code-styling-requirements)) +* Verify and acknowledge license (see [License for contributions](#license-for-contributions)) * Test building with various configurations: - * `buildtest.sh` + * `buildtest.sh` * Verify building source distribution: - * `make dist` (and try rebuilding from the resulting tar file) + * `make dist` (and try rebuilding from the resulting tar file) * Run DejaGNU unit tests: - * `make test` + * `make test` * Document Regression Runs and plans for continued maintenance of the feature ### Changelog @@ -118,7 +119,7 @@ website](http://www.linuxfoundation.org/content/how-participate-linux-community- to be a helpful resource. -#### Code submission - Github Pull Request (Strongly Preferred) +### Code submission - Github Pull Request (Strongly Preferred) Preferred submission of code is by using a Github Pull Request against the Develop branch. Code submitted by Pull Request will have an email generated to @@ -133,7 +134,7 @@ Further (manual) code review and discussion happens after the merge into the develop branch. -#### Code submission - Mailing Patch to PROJECT-Devel list +### Code submission - Mailing Patch to PROJECT-Devel list As an alternative submission, a patch can be mailed to the PROJECT-Devel mailing list. Preferred way to send the patch is using git send-mail. Patches @@ -144,7 +145,7 @@ the patch is then merged into the develop branch. Further (manual) code review and discussion happens after the merge into the develop branch. -Sending patch to mailing list +#### Sending patch to mailing list The recommended way to send the patch (or series of NN patches) to the list is by using ‘git send-email’ as follows (assuming they are the most recent NN @@ -172,10 +173,11 @@ and will allow your changes to merge faster * You should automatically receive an email with the test results within less than 2 hrs of the submission. If you don’t get the email, then check status on the github pull request (if submitted by pull request) or on - Patchwork at https://patchwork.PROJECT.org (if submitted as patch to - mailing list). + Patchwork at + [https://patchwork.PROJECT.org](https://patchwork.PROJECT.org) (if + submitted as patch to mailing list). * Please notify PROJECT-Devel mailing list if you think something doesn’t - work + work * If the tests failed: * In general, expect the community to ignore the submission until the tests pass. @@ -202,8 +204,9 @@ and will allow your changes to merge faster ### File header required for new files added -New files need to have a Copyright header (see License for contributions above) -added to the file. Preferred form of the header is as follows: +New files need to have a Copyright header (see [License for +contributions](#license-for-contributions) above) added to the file. Preferred +form of the header is as follows: ``` /* @@ -225,6 +228,8 @@ added to the file. Preferred form of the header is as follows: Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ + +#include <zebra.h> ``` ### Adding Copyright claims to already existing file diff --git a/render_md.py b/render_md.py new file mode 100644 index 0000000000..a819c784e8 --- /dev/null +++ b/render_md.py @@ -0,0 +1,24 @@ +#!/usr/bin/env python +# written 2016 by David Lamparter, placed in Public Domain. +import sys, markdown + +template = '''<html><head><meta charset="UTF-8"><style type="text/css"> +body { max-width: 45em; margin: auto; margin-top: 2em; margin-bottom: 2em; + font-family:Fira Sans,sans-serif; text-align: justify; } +pre, code { font-family:Fira Mono,monospace; } +pre > code { display: block; padding:0.5em; border:1px solid black; + background-color:#eee; color:#000; } +h2 { margin-top: 3em; text-decoration: underline; } +h3 { margin-top: 2em; font-weight: normal; font-style: italic; } +h4 { font-weight: normal; font-style: italic; } +</style></head><body> +%s +</body></html> +''' + +md = markdown.Markdown(extensions=['extra', 'toc']) + +for fn in sys.argv[1:]: + with open(fn, 'r') as ifd: + with open('%s.html' % (fn), 'w') as ofd: + ofd.write((template % (md.convert(ifd.read().decode('UTF-8')))).encode('UTF-8')) |