From cfb30b32f379389301bb04436c8303b6f7ae808f Mon Sep 17 00:00:00 2001 From: Muescha <184316+muescha@users.noreply.github.com> Date: Thu, 21 Dec 2023 16:42:04 +0100 Subject: [PATCH] Update CONTRIBUTING.md (#509) * Update CONTRIBUTING.md fix: - bullet points - fix link to custom plugins - add info about appending to `jc/lib.py` * Update CONTRIBUTING.md fix numbering * typo: lowercase --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8bc00f7b..43d6ee0a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,10 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu 1. Open an issue to discuss the new feature, bug fix, or parser before opening a pull request. For new parsers, it is important to agree upon a schema before developing the parser. 2. Fork the repo and create your branch from `dev`, if available, otherwise `master`. -3. For new parsers: Use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py) parsers as a template to get started. You can even place a new parser python module file in the [parser plugin directory](https://github.com/kellyjonbrazil/jc#custom-parsers) to get started right away with just a standard `jc` installation. +3. For new parsers: + - Templates: Use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py) parsers as a template to get started. + - Local development: You can even place a new parser python module file in the [parser plugin directory](https://github.com/kellyjonbrazil/jc#parser-plugins) to get started right away with just a standard `jc` installation. + - Parser registry: Add the parser name to the [jc/lib.py](https://github.com/kellyjonbrazil/jc/blob/master/jc/lib.py) file. 4. If you've added code that should be tested, add tests. All new parsers should have several sample outputs and tests. 5. Documentation is auto-generated from docstrings, so ensure they are clear and accurate. 6. Ensure the test suite passes. (Note: "**America/Los_Angeles**" timezone should be configured on the test system)