Skip to content

Commit

Permalink
Merge pull request #15 from etclabscore/dev
Browse files Browse the repository at this point in the history
Minor tweaks, mostly grammatical flavor
  • Loading branch information
shanejonas committed Feb 1, 2019
2 parents ddd17a5 + f7240cc commit 3c08613
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CONVENTIONAL_COMMITS.md
@@ -1,6 +1,6 @@
# Conventional Commits 1.0.0-beta.2

> This spec is a direct copied here from [http://conventionalcommits.org](http://conventionalcommits.org). It lives here as a reference documentation for new contributors.
> This spec is a direct copy from [http://conventionalcommits.org](http://conventionalcommits.org). It lives here as a reference document for new contributors.
## Summary

Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions README.md
@@ -1,10 +1,10 @@
# Pristine

Pristine is an open source repository in its original condition. Its goal is to be a starting point for open source repositories wanting to follow Documentation Driven Development. It is also a place for existing projects to find resources to augment current documentation.
Pristine is an open source repository in its original condition. Its goal is to be a starting point for new open source projects following a Documentation Driven Development pattern, as well as a resource from which to augment existing documentation.

## Documentation Driven Development

There are many ways to drive open source development, starting at the README gives a middle ground between technical specifications and non-technical. This promotes open source contribution and engagement.
There are many ways to drive open source development. Organizing solutions to this challenge around the README gives a middle ground between technical and non-technical specifications.

> By the same principle a beautifully crafted library with no documentation is also damn near worthless. If your software solves the wrong problem or nobody can figure out how to use it, there’s something very bad going on.
Expand Down
6 changes: 3 additions & 3 deletions RELEASING.md
Expand Up @@ -8,13 +8,13 @@ When using the name 'version' we mean the versioning scheme described in [VERSIO

## Introduction

This document is to describe the release pipeline, which is taking the result of the artifacts created in the [building step](BUILDING.md) and publish a release to the various release targets for the project.
This document is to describe the release pipeline, which is taking the result of the artifacts created according to [BUILDING.md](BUILDING.md) and publish a release to the various release targets for the project.

We propose:
- a set of release targets that are allowable
- a pipeline for handling the release folder's artifacts

It is NOT the purpose of this document to describe how a project might create a build, NOR is it describing a strcture in which projects MUST write build artifacts to. It is describing the structure of the releases themselves, however.
It is NOT the purpose of this document to describe how a project might create a build, NOR is it describing a strcture in which projects MUST write build artifacts to. It is describing the structure of the releases themselves.

## Release Targets
1. Github
Expand All @@ -33,7 +33,7 @@ in summary, we will simply:
### Sign the releases.
- MUST be a pgp signature
- MUST be the same pgp key as is registered with Github
- MUST be a detached signature
- MUST be a detached ascii-armored (.asc) signature
- All files in the build folder MUST have an associated signature file

### Generate Changelog
Expand Down

0 comments on commit 3c08613

Please sign in to comment.