Skip to content

Commit

Permalink
CONTRIBUTING.md and README update
Browse files Browse the repository at this point in the history
  • Loading branch information
meunierlf committed Feb 20, 2023
1 parent f7c7ffa commit 28f96f5
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributing to taylorism

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
...
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,8 @@ as an independent Python package.
The documentation is available on ReadTheDocs: [https://taylorism.readthedocs.io/](https://taylorism.readthedocs.io/)

A few examples are provided in: [src/taylorism/examples.py](https://github.com/UMR-CNRM/taylorism/blob/master/src/taylorism/examples.py)

## Contributing

Please review [CONTRIBUTING.md](CONTRIBUTING.md) for details on our
development process.

0 comments on commit 28f96f5

Please sign in to comment.