Add info about bumping API version to docs.dev (#4454)

* Add views count for authenticated users articles [#4250]

* Bump API version to 0.5.6 [#4250]

* Add info about bumping API docs version requirement

* Fix Create pull request link by linking to the docs
This commit is contained in:
Anna Anks Nowak 2019-10-16 15:04:36 +02:00 committed by Ben Halpern
parent 9c76663e1a
commit c4b5530e2e
3 changed files with 6 additions and 1 deletions

View file

@ -37,7 +37,7 @@ When in doubt, ask a [core team member](https://github.com/thepracticaldev/dev.t
2. Create a branch with your GitHub username as a prefix and the ID of the [issue](https://github.com/thepracticaldev/dev.to/issues) as a suffix, for example: `git checkout -b USERNAME/that-new-feature-1234` or `git checkout -b USERNAME/fixing-that-bug-1234` where `USERNAME` should be replaced by your username and `1234` is the ID of the issue tied to your pull request. If there is no issue, you can leave the number out.
3. Code and commit your changes. Bonus points if you write a [good commit message](https://chris.beams.io/posts/git-commit/): `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin USERNAME/that-new-feature-1234`
5. [Create a pull request](https://github.com/thepracticaldev/dev.to/#create-a-pull-request) for your branch 🎉
5. [Create a pull request](https://docs.dev.to/getting-started/pull-request/) for your branch 🎉
## Contribution guideline

View file

@ -11,6 +11,10 @@ The API docs follow the [OpenAPI 3 specification](http://spec.openapis.org/oas/v
We auto-generate the documentation from `api_v0.yml` within the `/docs` directory.
We use [ReDoc](https://github.com/Redocly/redoc) to turn the OpenAPI 3 format into a readable and searchable HTML documentation.
## Updating API docs
Whenever you make changes to the API docs, make sure to bump the version in `api_v0.yml`.
## Running and editing the Docs Locally
If you want to browse the documentation locally you can use:

View file

@ -7,6 +7,7 @@ title: Preparing a Pull Request
- Try to keep the pull requests small. A pull request should try its very best to address only a single concern.
- Make sure all tests pass and add additional tests for the code you submit. Check out the [testing guide](/tests).
- Document your reasoning behind the changes. Explain why you wrote the code in the way you did. The code should be clear enough to explain what it does.
- If you are making changes to the API, make sure to update the version in the docs. Check out [the guide here](/contributing_api).
- If there's an existing issue related to the pull request, reference to it by adding something like `References/Closes/Fixes/Resolves #305`, where 305 is the issue number. See [GitHub's own guide on closing issues via PR](https://github.com/blog/1506-closing-issues-via-pull-requests).
- If you follow the pull request template, you can't go wrong.