Contributing and README update

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Script/Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Environment (please complete the following information):**
+ - Python version [e.g. 3.11.1]
+ - OS: [e.g. Linux/MacOS]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to thenamelisttool
+
+Contributions are always welcome.
+
+## Pull Request Process
+
+Pull requests are the best way to propose changes to the codebase (we use Github
+Flow). We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from master.
+2. If you've added code that should be tested, add tests.
+3. If you add a new sub-package, update the documentation.
+4. Make sure your code lints (see below).
+5. Ensure the test suite passes (see below).
+6. Ensure the documentation builds (see below).
+7. Issue the pull request!
+
+## Code style and basic checks
+
+* `pyflakes` should run without any error.
+* The code needs to be PEP8 compliant (the line length should not exceed  120
+* characters). This can be checked using `pycodestyle`.
+* `pydocstyle` should run without error.
+
+Here is a typical way to run all these tests (from the repository root)::
+
+    $ pyflakes src tests
+    $ pycodestyle --max-line-length=120 --ignore=W504 src
+    $ pycodestyle --max-line-length=120 --ignore=W504 tests
+    $ pydocstyle
+
+If no warning pops up, that(s) ok!
+
+## Test suite
+
+Launching the `pytest` command at the repository root will run all the unit
+tests. 
+
+## Documentation builds
+
+The `docs` subdirectory is equipped with a Makefile::
+
+    $ cd docs
+    $ make
+    ...

README.md

@@ -8,5 +8,10 @@ The main objectives of this package is to provide command line tools useful to
 work with namelists or pack of namelists (update them, compare them, ...).
 
 Originally, it has been developed as part of the *Vortex* project. Recently
-the  code has been extracted from the *Vortex* code base. It is now presented
+the code has been extracted from the *Vortex* code base. It is now presented
 as an independent Python package.
+
+## Contributing
+
+Please review [CONTRIBUTING.md](CONTRIBUTING.md) for details on our
+development process.