Skip to content

Commit

Permalink
Add coding style in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
naokazuterada committed Feb 24, 2018
1 parent 4ad9492 commit 50ea274
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
9 changes: 8 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions messages/2.7.2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# MarkdownTOC - 2.7.2

## Changes

- Replace name attribute to id Ref: #116
- Follow pycodestyle(pep8) lint rules
Contribution by @Kristinita

1 comment on commit 50ea274

@jonasbn
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work :-)

Please sign in to comment.