Skip to content

Commit

Permalink
Merge pull request #84 from DataONEorg/develop
Browse files Browse the repository at this point in the history
HashStore 1.1.0 Release
  • Loading branch information
doulikecookiedough authored Oct 2, 2024
2 parents 294b4fe + 4b491d0 commit c11d5bc
Show file tree
Hide file tree
Showing 19 changed files with 6,848 additions and 3,384 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ venv/
ENV/
env.bak/
venv.bak/
.idea

# Spyder project settings
.spyderproject
Expand Down
30 changes: 15 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Contributing to HashStore

:tada: First off, thanks for contributing! :tada:
**🎉 First off, thanks for contributing! 🎉**

- [Types of contributions](#types-of-contributions)
- [Pull Requests](#pull-requests)
- [Development Workflow](#development-workflow)
- [Release process](#release-process)
- [Testing](#testing)
- [Code style](#code-style)
- [Contributor license agreement](#contributor-license-agreement)
- [Types of Contributions](#types-of-contributions)
- [🌳 Pull Requests](#pull-requests)
- [🔀 Development Workflow](#development-workflow)
- [🚀 Release Process](#release-process)
- [🔬 Testing](#testing)
- [🎨 Code Style](#code-style)
- [📄 Contributor License Agreement](#contributor-license-agreement)

## Types of contributions
## Types of Contributions

We welcome all types of contributions, including bug fixes, feature enhancements,
bug reports, documentation, graphics, and many others. You might consider contributing by:
Expand All @@ -29,7 +29,7 @@ made to increase the value of HashStore to the community. We strive to
incorporate code, documentation, and other useful contributions quickly and
efficiently while maintaining a high-quality software product.

## Pull Requests
## 🌳 Pull Requests
We use the pull-request model for contributions. See [GitHub's help on pull-requests](https://help.github.com/articles/about-pull-requests/).

In short:
Expand All @@ -43,7 +43,7 @@ In short:
- our team may request changes before we will approve the Pull Request, or we will make them for you
- once the code is reviewed, our team will merge in your changes to `develop` for the next planned release

## Development Workflow
## 🔀 Development Workflow

Development is managed through the git repository at https://github.com/DataONEorg/hashstore. The repository is organized into several branches, each with a specific purpose.

Expand Down Expand Up @@ -104,7 +104,7 @@ gitGraph
merge develop id: "11" tag: "v1.1.0"
```

## Release process
## 🚀 Release Process

1. Our release process starts with integration testing in a `develop` branch. Once all
changes that are desired in a release are merged into the `develop` branch, we run
Expand All @@ -115,7 +115,7 @@ reflect the new release and the `develop` branch can be fast-forwarded to sync w
start work on the next release.
3. Releases can be downloaded from the [GitHub releases page](https://github.com/DataONEorg/hashstore/releases).

## Testing
## 🔬 Testing

**Unit and integration tests**. HashStore has a full suite of `pytest` tests in the `tests` subdirectory.
Any new code developed should include a robust set of tests for each public
Expand All @@ -127,15 +127,15 @@ or merging to `develop`.
Tests are automatically run via GitHub Actions. Check the root `README.md` file
for this GitHub Actions status badge and make sure it says "Passing":

## Code style
## 🎨 Code Style

Code should be written to professional standards to enable clean, well-documented,
readable, and maintainable software. While there has been significant variability
in the coding styles applied historically, new contributions should strive for
clean code formatting. We generally follow PEP8 guidelines for Python code formatting,
typically enforced through the `black` code formatting package.

## Contributor license agreement
## 📄 Contributor License Agreement

In order to clarify the intellectual property license
granted with Contributions from any person or entity, you agree to
Expand Down
Loading

0 comments on commit c11d5bc

Please sign in to comment.