Skip to content
This repository has been archived by the owner on Sep 21, 2022. It is now read-only.

Arrange the docs by filename and merge few files together #305

Merged
merged 3 commits into from
Dec 2, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/contributing.md → docs/04_contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ method before making a change.
The following section explains various suggestions and procedures to note during development.

### First Steps
* Familiarizing yourself with our [coding style guidelines.](coding-style-guide.md).
* Familiarizing yourself with our [coding style guidelines.](05_coding-style-guide.md).
* Familiarizing yourself with the [Makefile](../Makefile) commands, for example, `build`, `format`, `test`, `lint`.
`make help` will print all available commands with some description.

Expand Down Expand Up @@ -59,7 +59,7 @@ $ <Iterate your development>
$ git push fork <your_PR_branch>
```

1. If your change affects users (adds,removes or changes a feature) add the item to the [CHANGELOG](CHANGELOG.md).
1. If your change affects users (adds,removes or changes a feature) add the item to the [CHANGELOG](08_CHANGELOG.md).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hm, I think we should keep the CHANGELOG filename unchanged. Ideally we want it last in the docs list, but it is ok even if shows at the begining.

1. Add e2e tests for new features and changes to functionality. Add unit tests for key components of the packages.
1. A PR will me merged once the PR has been approved by at least one developer with write access.
1. If you feel like your PR is waiting too long for a review, feel free to ping in the [Discord](https://discord.gg/n7drGjh) channel for a review!
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/release-process.md → docs/07_release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ later follow-up.

# Cutting a release

## Update `CHANGELOG.md`
## Update `08_CHANGELOG.md`
Do this in a PR against `master` as this gives others the opportunity to chime in on the release and the changelog changes.

Note:
> that `CHANGELOG.md` should only document changes relevant to users of the project, including external API changes, performance improvements, and new features. Do not document changes of internal interfaces, code refactorings and clean-ups, changes to the build process, etc. People interested in these are asked to refer to the git history.
> that `08_CHANGELOG.md` should only document changes relevant to users of the project, including external API changes, performance improvements, and new features. Do not document changes of internal interfaces, code refactorings and clean-ups, changes to the build process, etc. People interested in these are asked to refer to the git history.

## Draft the new release
On `master` tag the current commit as a new release via the following commands:
Expand Down
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ A list of all PSR's(pre specified requests) and the expected data can be found [


## Instructions for deployment
- [Telliot Instructions](the-guide.md)
- [Telliot Instructions](02_the-guide.md)

## Contributing and building from source
Contributions are very welcome!<br/>
See our [contributing.md](contributing.md) for more information.
See our [04_contributing.md](04_contributing.md) for more information.

## Run with Docker
Available tags: https://hub.docker.com/u/tellor
Expand Down