Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add project authorship/citation/funding metadata #286

Merged
merged 15 commits into from
Sep 20, 2023
Merged
74 changes: 74 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
cff-version: 1.2.0
message: |
Please cite this software using these metadata.
Authors are listed in alphabetical order.

title: "earthaccess"
# TODO:
# doi: ""
abstract: "Python Library for NASA Earthdata APIs"
contact:
- name: "The earthaccess community"
website: "https://github.com/nsidc/earthaccess/discussions"
- name: "NSIDC"
email: "[email protected]"
type: "software"
license: ["MIT"]
keywords:
- "data"
- "Remote sensing"
- "Cloud computing"
- "authentication"
- "Earthdata Login"

url: "https://earthaccess.readthedocs.io"
repository-code: "https://github.com/nsidc/earthaccess"

version: "0.5.3"
date-released: "2023-08-01"

authors:
- family-names: "Barrett"
given-names: "Andrew"
orcid: "https://orcid.org/0000-0003-4394-5445"
website: "https://github.com/andypbarrett"
- family-names: "Battisto"
given-names: "Chris"
orcid: "https://orcid.org//0000-0002-9608-3634"
website: "https://github.com/battistowx"
- family-names: "Bourbeau"
given-names: "James"
orcid: "https://orcid.org/0000-0003-2164-7789"
website: "https://github.com/jrbourbeau"
- family-names: "Fisher"
given-names: "Matt"
orcid: "https://orcid.org/0000-0003-3260-5445"
website: "https://mfisher87.github.io/"
- family-names: "Kennedy"
given-names: "Joseph"
orcid: "https://orcid.org/0000-0002-9348-693X"
website: "https://github.com/jhkennedy"
- family-names: "Lopez"
given-names: "Luis"
orcid: "https://orcid.org/0000-0003-4896-3263"
website: "https://github.com/betolink"
- family-names: "Lowndes"
given-names: "Julia"
orcid: "https://orcid.org/0000-0003-1682-3872"
website: "https://github.com/jules32"
- family-names: "Scheick"
given-names: "Jessica"
orcid: "https://orcid.org/0000-0002-3421-4459"
website: "https://github.com/JessicaS11"
- family-names: "Steiker"
given-names: "Amy"
orcid: "https://orcid.org/0000-0002-3039-0260"
website: "https://github.com/asteiker"



references:
- type: "grant"
institution:
name: "National Aeronautics and Space Administration"
number: "20-TWSC20-2-0003"
44 changes: 36 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,16 +68,44 @@ scripts/format.sh
- you must update the documentation
- you must run the above scripts to format and line

## Pull Request Process
## Pull Request process

1. Ensure you include test coverage for all changes
2. Ensure your code is formatted properly via the command above
3. Update the documentation and the README.md with details of changes to the interface, this includes new environment
variables, function names, decorators, etc..
4. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
5. You may merge the Pull Request in once you have the sign-off of another developers, or if you
do not have permission to do that, you may request the reviewer to merge it for you.
2. Ensure your code is formatted properly following this document
3. Update the documentation and the README.md with details of changes to the interface,
this includes new environment variables, function names, decorators, etc.
3. Update `CHANGELOG.md` with details about your change in a section titled
`Unreleased`. If one does not exist, please create one.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feels like we should have a PR template with a checklist for things like this!

4. You may merge the Pull Request in once you have the sign-off of another developers,
or if you do not have permission to do that, you may request the reviewer to merge it
for you.

## Release process

> :memo: The versioning scheme we use is [SemVer](http://semver.org/). Note that until
> we agree we're ready for v1.0.0, we will not increment major version.

0. Ensure all desired features are merged to `main` branch and `CHANGELOG` is updated.
1. Use `bump-my-version` to increase the version number in all needed places, e.g. to
increase the minor version (`1.2.3` to `1.3.0`):
```
bumpversion bump minor
```
2. Push a tag on the new commit containing the version number, prefixed with `v`, e.g.
`v1.3.0`.
3. [Create a new GitHub Release](https://github.com/nsidc/earthaccess/releases/new). We
hand-curate our release notes to be valuable to humans. Please do not auto-generate
release notes and aim for consistency with the GitHub Release descriptions from other
releases.

> :gear: After the GitHub release is published, multiple automations will trigger:
>
> - Zenodo will create a new DOI.
> - GitHub Actions will publish a PyPI release.

> :memo: `earthaccess` is published to conda-forge through the
> [earthdata-feedstock](https://github.com/conda-forge/earthdata-feedstock), as this
> project was renamed early in its life. The conda package is named `earthaccess`.

---

Expand Down
Loading