Merge branch 'master' of https://github.com/wearehive/project-guidelines
This commit is contained in:
commit
3e232659f4
10
README.md
10
README.md
@ -25,30 +25,25 @@ We use [Feature-branch-workflow](https://www.atlassian.com/git/tutorials/compari
|
||||
```
|
||||
git checkout -b <branchname>
|
||||
```
|
||||
|
||||
* Make Changes
|
||||
```
|
||||
git add
|
||||
git commit -m "description of changes"
|
||||
```
|
||||
|
||||
* Sync with remote to get changes you’ve missed
|
||||
```
|
||||
git checkout develop
|
||||
git pull
|
||||
```
|
||||
|
||||
* Update your feature branch with latest changes from develop by interactive rebase ([Here is why](https://www.atlassian.com/git/tutorials/merging-vs-rebasing#the-golden-rule-of-rebasing))
|
||||
```
|
||||
git checkout <branchname>
|
||||
git -i rebase develop
|
||||
```
|
||||
|
||||
* If you don’t have conflict skip this step. If you have conflicts, [resolve them](https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/) and continue rebase
|
||||
```
|
||||
git rebase --continue
|
||||
```
|
||||
|
||||
* Push your branch
|
||||
```
|
||||
git push
|
||||
@ -120,7 +115,6 @@ Before using a package check its Github open issues, daily downloads and number
|
||||
|
||||
## 6. Structure and Naming <a name="structure-and-naming"></a>
|
||||
* Organize your files around product features / pages / components, not Roles:
|
||||
|
||||
```
|
||||
// BAD
|
||||
.
|
||||
@ -144,7 +138,6 @@ Before using a package check its Github open issues, daily downloads and number
|
||||
| ├── user.js
|
||||
| └── user.test.js
|
||||
```
|
||||
|
||||
* Place your test files next to the implementation.
|
||||
* Put your additional test files to a separate test folder to avoid confusion.
|
||||
* Use a `./config` folder. Values to be used in config files are provided by environmental variables.
|
||||
@ -323,15 +316,12 @@ Required: id=[integer]
|
||||
Optional: photo_id=[alphanumeric]
|
||||
```
|
||||
* If the request type is POST, provide a working examples. URL Params rules apply here too. Separate the section into Optional and Required.
|
||||
|
||||
* Success Response, What should be the status code and is there any return data? This is useful when people need to know what their callbacks should expect!
|
||||
```
|
||||
Code: 200
|
||||
Content: { id : 12 }
|
||||
```
|
||||
|
||||
* Error Response, Most endpoints have many ways to fail. From unauthorised access, to wrongful parameters etc. All of those should be listed here. It might seem repetitive, but it helps prevent assumptions from being made. For example
|
||||
|
||||
```
|
||||
"Code": 403
|
||||
"message" : "Authentication failed",
|
||||
|
Loading…
x
Reference in New Issue
Block a user