Api documentation #9
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fatmali
reviewed
Dec 13, 2019
CONTRIBUTIONS.md
Outdated
| We use the git workflow on our projects. If you are unfamiliar with the workflow, here is an awesome primer by [Atlassian](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). Basically, we have a `master` branch that serves for official release cycles, a `develop` branch that sums up features for the next release. Each `feature/chore/bug-fix` needs to be in its own branch originating from the `develop` branch. When the develop branch has acquired enough features for a `release`, a temporary branch is created (intuitively named **release**) to mark the next release cycle. At this point, **No new** features will be allowed, just bug fixes or documentations. When we are confident enough and after extensive testing, the new branch is merged to the `master` with a version number, it is merged into the `develop` branch to get the fixes or modifications made on the `release` branch. After all that, the branch is deleted and we go on and start working on features for the next release (from the `develop` branch). | ||
|
|
||
| ## API Documentation Style Guide |
There was a problem hiding this comment.
Hi @yegow, great work on the docs! The team decided to move forward with swagger instead of apiary because of the completely free and open swagger ui that swagger offers which comes with a sandbox and documentation element. So sorry you have to remove this bit, I'll gladly merge in the rest after you make the changes.
fatmali
reviewed
Dec 13, 2019
README.md
Outdated
| @@ -25,4 +25,7 @@ yarn test | |||
| ``` | |||
| ## Contributions | |||
|
|
|||
| Be sure to go through the [contribution guidelines](https://github.com/DevCEldoret/devceldoret-backend/blob/development/CONTRIBUTIONS.md) | |||
| Be sure to go through the [contribution guidelines](https://github.com/DevCEldoret/devceldoret-backend/blob/development/CONTRIBUTIONS.md). | |||
fatmali
requested changes
Dec 13, 2019
Closed
|
Looks good? @fatmali |
fatmali
approved these changes
Dec 14, 2019
fatmali
pushed a commit
that referenced
this pull request
Dec 21, 2019
* Added workflow and API contribution guides * More edits * Added Apiary link to README.md * event model suggestion * Removed Apiary related file and info
fatmali
pushed a commit
that referenced
this pull request
Jan 9, 2020
* Added workflow and API contribution guides * More edits * Added Apiary link to README.md * event model suggestion * Removed Apiary related file and info
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This partially addresses issue #7.