Skip to content
This repository has been archived by the owner on Feb 27, 2021. It is now read-only.

Commit

Permalink
fix: replace github for Github
Browse files Browse the repository at this point in the history
  • Loading branch information
shanejonas committed Jan 31, 2019
1 parent 227b53a commit b6b9d42
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

> This document is inspired by [elasticsearch/CONTRIBUTING.md](https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md)
Adding a `CONTRIBUTING.md` to a github repository enables a link to that file in the pull request or create an issue page. This document should guide potential contributors toward making a successful and meaningful impact on the project, and can save maintainers time and hassle caused by improper pull requests and issues. You can learn more about the features that are enabled by github when this file is present [here](https://help.github.com/articles/setting-guidelines-for-repository-contributors/).
Adding a `CONTRIBUTING.md` to a Github repository enables a link to that file in the pull request or create an issue page. This document should guide potential contributors toward making a successful and meaningful impact on the project, and can save maintainers time and hassle caused by improper pull requests and issues. You can learn more about the features that are enabled by Github when this file is present [here](https://help.github.com/articles/setting-guidelines-for-repository-contributors/).

## How to contribute

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, [submitting github issues](https://help.github.com/articles/creating-an-issue/), bug reports, feature requests and writing code.
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, [submitting Github issues](https://help.github.com/articles/creating-an-issue/), bug reports, feature requests and writing code.

## License

This repository uses the [The Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).

## Bug reports

If you think you've found a bug in the software, first make sure you're testing against the *latest* version of the software -- your issue may have been fixed already. If it's not, please check out the issues list on github and search for similar issues that have already been opened. If there are no issues then please [submit a github issue](https://help.github.com/articles/creating-an-issue/).
If you think you've found a bug in the software, first make sure you're testing against the *latest* version of the software -- your issue may have been fixed already. If it's not, please check out the issues list on Github and search for similar issues that have already been opened. If there are no issues then please [submit a Github issue](https://help.github.com/articles/creating-an-issue/).

If you can provide a small test case it would greatly help the reproduction of a bug, as well as a a screenshot, and any other information you can provide.

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Using conventions, documentation and specifications make it easier to:
- ease onboarding
- build and use composable tools
- promote open source contribution and engagement
- promote issue and feature discussion on github itself
- promote issue and feature discussion on Github itself

#### Resources

Expand All @@ -36,13 +36,13 @@ To get started, [fork](https://help.github.com/articles/fork-a-repo/) or [duplic

### Contributing

How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING](BUILDING.md) and [RELEASING](RELEASING.md) respectively.
How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING.md](BUILDING.md) and [RELEASING.md](RELEASING.md) respectively.

### Requirements

#### Docker:

Docker is used as a building block in [BUILDING](BUILDING.md) and [RELEASING](RELEASING.md). Here are the resources needed to get started and install docker:
Docker is used as a building block in [BUILDING.md](BUILDING.md) and [RELEASING.md](RELEASING.md). Here are the resources needed to get started and install docker:

- [Install Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/)
- [Install Docker Desktop for Windows](https://docs.docker.com/docker-for-windows/install/)
Expand Down
6 changes: 3 additions & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ We propose:
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.

## Release Targets
1. github
1. Github
2. (tentative) docker

## Release Pipeline
Expand All @@ -32,7 +32,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 the same pgp key as is registered with Github
- MUST be a detached signature
- All files in the build folder MUST have an associated signature file

Expand All @@ -58,7 +58,7 @@ simple as `git push`.
For each of the desired release targets, prepare and push the release.

#### Github Release
Using [github release tool](https://github.com/c4milo/github-release), push a release with the following fields:
Using [Github release tool](https://github.com/c4milo/github-release), push a release with the following fields:


| Field name | Content |
Expand Down

0 comments on commit b6b9d42

Please sign in to comment.