Skip to content

Commit 2116c5c

Browse files
authored
Update formatting and headings in CONTRIBUTING.md
1 parent 570aea1 commit 2116c5c

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Hi! Thanks for your interest in contributing to
1212
Please refer to our
1313
[Contributor Covenant Code of Conduct](https://github.com/PyThaiNLP/pythainlp/blob/dev/CODE_OF_CONDUCT.md).
1414

15-
## Issue Report and Discussion
15+
## Issue report and discussion
1616

1717
- Discussion: <https://github.com/PyThaiNLP/pythainlp/discussions>
1818
- GitHub issues (for problems and suggestions):
@@ -22,7 +22,7 @@ Please refer to our
2222

2323
## Code
2424

25-
## Code Guidelines
25+
## Code guidelines
2626

2727
- Follow [PEP8][pep8], use [black][black] with `--line-length` = 79;
2828
- Name identifiers (variables, classes, functions, module names)
@@ -185,19 +185,19 @@ Warning messages should be clear, concise, and parseable:
185185
Do **not** rely on the default `UserWarning` by omitting `category`.
186186
Always supply `category` explicitly for clarity and greppability.
187187

188-
### Version Control System
188+
### Version control system
189189

190190
- We use [Git](https://git-scm.com/) as our
191191
[version control system](https://en.wikipedia.org/wiki/Revision_control),
192192
so it may be a good idea to familiarize yourself with it.
193193
- You can start with the [Pro Git book](https://git-scm.com/book/) (free!).
194194

195-
### Commit Message
195+
### Commit message
196196

197197
- [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)
198198
- [Commit Verbs 101: why I like to use this and why you should also like it.](https://chris.beams.io/posts/git-commit/)
199199

200-
### Pull Request
200+
### Pull request
201201

202202
- We use the famous [gitflow][] to manage our branches.
203203
- When you create pull requests on GitHub, GitHub Actions will run tests
@@ -250,9 +250,9 @@ Make sure the tests pass on GitHub Actions.
250250

251251
See more in [tests/README.md](./tests/README.md)
252252

253-
## Installing and Building
253+
## Installing and building
254254

255-
### Installing for Development
255+
### Installing for development
256256

257257
Install PyThaiNLP in editable mode with core dependencies:
258258

@@ -273,7 +273,7 @@ pip install -e ".[compact,extra]"
273273
See all available optional dependency groups in `pyproject.toml`
274274
under `[project.optional-dependencies]`.
275275

276-
### Building Distribution Packages
276+
### Building distribution packages
277277

278278
To build source distribution and wheel:
279279

@@ -340,13 +340,13 @@ Thanks to all
340340
[contributors](https://github.com/PyThaiNLP/pythainlp/graphs/contributors).
341341
(Image made with [contributors-img](https://contributors-img.firebaseapp.com))
342342

343-
### Development Leads
343+
### Development leads
344344

345345
- Wannaphong Phatthiyaphaibun <wannaphong@pythainlp.org> - foundation,
346346
distribution and maintenance
347347
- Korakot Chaovavanich - initial tokenization and soundex codes
348348
- Charin Polpanumas - classification and benchmarking
349-
- Arthit Suriyawongkul - localization functions, documentation,
349+
- Arthit Suriyawongkul - localization functions, documentation, security,
350350
tests, refactoring, code modernization, and CI/build infrastructure
351351
- Lalita Lowphansirikul - documentation
352352
- Pattarawat Chormai - benchmarking
@@ -365,7 +365,7 @@ Thanks to all
365365

366366
## References
367367

368-
- **[Maximum Matching]** --
368+
- **[Maximum matching]** --
369369
Manabu Sassano. Deterministic Word Segmentation Using Maximum
370370
Matching with Fully Lexicalized Rules.
371371
Retrieved from

0 commit comments

Comments
 (0)