From 50ea274896ad17b7ebebfea3011e4d110d9210f1 Mon Sep 17 00:00:00 2001 From: Naokazu Terada Date: Sat, 24 Feb 2018 11:59:42 +0900 Subject: [PATCH] Add coding style in CONTRIBUTING.md --- .github/CONTRIBUTING.md | 9 ++++++++- messages/2.7.2.md | 7 +++++++ 2 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 messages/2.7.2.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ab7bd21..3291017 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -17,11 +17,18 @@ Patches for fixes, features, and improvements are accepted via pull requests. Pull requests should be based on the master branch, unless you want to contribute to an active branch for a specific topic. +#### Coding Style + +You should follow [pycodestyle](https://github.com/PyCQA/pycodestyle) (formerly called pep8). +You can do it easily with [Python PEP8 Autoformat](https://packagecontrol.io/packages/Python%20PEP8%20Autoformat). + +#### Test + You should use unit-tests for SublimeText by using [UnitTesting](https://github.com/randy3k/UnitTesting) plugin. 1. Install the UnitTesting plugin 2. Comment out or rename your own `MarkdownTOC.sublime-settings` so individual settings are not used during testing -3. [Run tests](https://github.com/randy3k/UnitTesting-example#running-tests) +3. [Run tests](https://github.com/randy3k/UnitTesting-example#running-tests) 4. Send Pull Request when tests pass All contributions are welcome diff --git a/messages/2.7.2.md b/messages/2.7.2.md new file mode 100644 index 0000000..9e27017 --- /dev/null +++ b/messages/2.7.2.md @@ -0,0 +1,7 @@ +# MarkdownTOC - 2.7.2 + +## Changes + +- Replace name attribute to id Ref: #116 +- Follow pycodestyle(pep8) lint rules + Contribution by @Kristinita