Skip to content

Commit

Permalink
Add developer documentation to the new docs (#144)
Browse files Browse the repository at this point in the history
* Add vector source of logos

* Add developer documentation

* Update contribute.md, add CoC. Fix mkdocs page gen

* Slight change to contributing page, changelog.

* Move CONTRIBUTE.md content to docs.
  • Loading branch information
BSchilperoort authored Apr 18, 2023
1 parent 6c85d09 commit fda4717
Show file tree
Hide file tree
Showing 10 changed files with 574 additions and 113 deletions.
70 changes: 3 additions & 67 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,71 +6,7 @@ way to propose new features.
# Readthedocs
For technical assistance with your contribution, please check the [contributing
guidelines on
readthedocs](https://era5cli.readthedocs.io/en/latest/contribute.html).
readthedocs](https://era5cli.readthedocs.io/en/latest/contribute/), and possibly the
[developer documentation](https://era5cli.readthedocs.io/en/latest/general_development/) as well.

# Making a release

## Author information
Ensure all authors are present in:

- `CITATION.cff`
- `era5cli/__version__.py`

## Confirm release info
Ensure the right date and upcoming version number (including release candidate
tag, if applicable) is set in:

- `CITATION.cff`
- `era5cli/__version__.py`
- `docs/source/conf.py`

## Update the changelog
Update `CHANGELOG.rst` with new features and fixes in the upcoming version.
Confirm that `README.rst` is up to date with new features as well.

## Release on GitHub
Open [releases](https://github.com/eWaterCycle/era5cli/releases) and draft a new
release. Copy the changelog for this version into the description (though note
that the description is in Markdown, so reformat from Rst if necessary).

Tag the release according to [semantic versioning
guidelines](https://semver.org/), preceded with a `v` (e.g.: v1.0.0). The
release title is the tag and the release date together (e.g.: v1.0.0
(2019-07-25)).

### Release candidate
When releasing a release candidate on Github, tick the pre-release box, and
amend the version tag with `-rc` and the candidate number. Ensure the release
candidate version is accurate in `CITATION.cff` and `era5cli/__version__.py`.
If the version number in these files is not updated, Zenodo release
workflows will fail.

Releasing a release candidate is not required, but can help detect bugs early.

## PyPI release workflow
Publishing a new release in github triggers the github Action workflow that
builds and publishes the package to test.PyPI or PyPI. Versions with "rc"
(release candidate) in their version tag will only be published to test.PyPI.
Other version tags will trigger a PyPI release. Inspect
`.github/workflows/publish-to-pypi.yml` for more information.

Confirm a release candidate on test.PyPI with:
```
pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ era5cli
```

## Release on Zenodo
Confirm the new release on [Zenodo](https://doi.org/10.5281/zenodo.3252665).

## Release on the Research Software Directory
Wait a few hours, then confirm the addition of a new release on the
[RSD](https://www.research-software.nl/software/era5cli).

If any contributors have been added, or the description of the software has
changed, this can be edited (by eScience Center employees) via the [RSD admin
interface](https://www.research-software.nl/admin/). More information about
this process (e.g. how to add a new contributor or new affiliation) can be
found in the [RSD
documentation](https://github.com/research-software-directory/research-software-directory/blob/master/docs/entering-data.md)
or in [this
blogpost](https://blog.esciencecenter.nl/the-research-software-directory-and-how-it-promotes-software-citation-4bd2137a6b8).
Note that if readthedocs is down or otherwise unavailable, the instructions are also available in [`docs/contribute.md`](./docs/contribute.md) and [`docs/general_development.md`](./docs/general_development.md)
3 changes: 2 additions & 1 deletion docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Add validator for `era5cli.txt` keys. This should provide better feedback to users and reduce user error.
- Added --splitmonths argument for `era5cli hourly`. This allows users to avoid a Request Too Large error.
- Added --dashed-varname argument, to produce names where the variable name is separated using hyphens. For example: `soil-type` vs. `soil_type`. For the ongoing discussion, see [#53](https://github.com/eWaterCycle/era5cli/issues/53).

**Changed:**

Expand All @@ -19,11 +20,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- When a file already exists and would be overwritten, the user is prompted for confirmation. This should prevent accidental overwriting of files. This check can be skipped with the `--overwrite` flag.
- The earliest valid start year of requests has been updated to 1950.
- Usage of `--prelimbe` now raises a deprecation warning. It will be deprecated in a future release, as all the back extension years are now included in the main products.
- The documentation has been fully overhauled, and now uses Markdown files & MkDocs.

**Dev changes:**

- `cli.py` has been refactored to make the structure more clear. Seperate argument builders are now in their own modules.
- The documentation has been overhauled, and now uses Markdown files & MkDocs.

## 1.3.2 - 2021-12-13
**Changed:**
Expand Down
128 changes: 128 additions & 0 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
<https://www.contributor-covenant.org/faq>. Translations are available at
<https://www.contributor-covenant.org/translations>.
Loading

0 comments on commit fda4717

Please sign in to comment.