Skip to content

Commit c11d5bc

Browse files
Merge pull request #84 from DataONEorg/develop
HashStore 1.1.0 Release
2 parents 294b4fe + 4b491d0 commit c11d5bc

19 files changed

Lines changed: 6848 additions & 3384 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ venv/
131131
ENV/
132132
env.bak/
133133
venv.bak/
134+
.idea
134135

135136
# Spyder project settings
136137
.spyderproject

CONTRIBUTING.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Contributing to HashStore
22

3-
:tada: First off, thanks for contributing! :tada:
3+
**🎉 First off, thanks for contributing! 🎉**
44

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

13-
## Types of contributions
13+
## Types of Contributions
1414

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

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

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

46-
## Development Workflow
46+
## 🔀 Development Workflow
4747

4848
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.
4949

@@ -104,7 +104,7 @@ gitGraph
104104
merge develop id: "11" tag: "v1.1.0"
105105
```
106106

107-
## Release process
107+
## 🚀 Release Process
108108

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

118-
## Testing
118+
## 🔬 Testing
119119

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

130-
## Code style
130+
## 🎨 Code Style
131131

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

138-
## Contributor license agreement
138+
## 📄 Contributor License Agreement
139139

140140
In order to clarify the intellectual property license
141141
granted with Contributions from any person or entity, you agree to

0 commit comments

Comments
 (0)