-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from rzrbld/feature/fix-release
fix group edit error
- Loading branch information
Showing
4 changed files
with
71 additions
and
5 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Adminio API Contribution Guide | ||
|
||
The owners of this repository welcomes your contribution. To make the process as seamless as possible, we recommend you read this contribution guide. | ||
|
||
## Development Workflow | ||
|
||
Start by forking the this GitHub repository, make changes in a branch and then send a pull request. We encourage pull requests to discuss code changes. Here are the steps in details: | ||
|
||
### Setup your adminio-api GitHub Repository | ||
Fork [Adminio API](https://github.com/rzrbld/adminio-api/fork) upstream source repository to your own personal repository. | ||
|
||
### Set up git remote as ``upstream`` | ||
```sh | ||
$ git clone https://github.com/rzrbld/adminio-api | ||
$ cd adminio-api | ||
$ git remote add upstream https://github.com/rzrbld/adminio-api | ||
$ git fetch upstream | ||
$ git merge upstream/master | ||
... | ||
``` | ||
|
||
### Create your feature branch | ||
Before making code changes, make sure you create a separate branch for these changes | ||
|
||
``` | ||
$ git checkout -b my-new-feature | ||
``` | ||
|
||
### Test changes | ||
After your code changes, make sure | ||
- To run `go build main.go` and see no errors | ||
- To squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request. | ||
- To run some tests. | ||
|
||
### Commit changes | ||
After verification, commit your changes. This is a [great post](https://chris.beams.io/posts/git-commit/) on how to write useful commit messages | ||
|
||
``` | ||
$ git commit -am 'Add some feature' | ||
``` | ||
|
||
### Push to the branch | ||
Push your locally committed changes to the remote origin (your fork) | ||
``` | ||
$ git push origin my-new-feature | ||
``` | ||
|
||
### Create a Pull Request | ||
Pull requests can be created via GitHub. Refer to [this document](https://help.github.com/articles/creating-a-pull-request/) for detailed steps on how to create a pull request. After a Pull Request gets peer reviewed and approved, it will be merged. | ||
|
||
## FAQs | ||
### How does adminio-api manages dependencies? | ||
``adminio-api`` uses `go mod` to manage its dependencies. | ||
- Run `go get foo/bar` in the source folder to add the dependency to `go.mod` file. | ||
|
||
To remove a dependency | ||
- Edit your code and remove the import reference. | ||
- Run `go mod tidy` in the source folder to remove dependency from `go.mod` file. | ||
|
||
### What are the coding guidelines? | ||
Refer: [Effective Go](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project. If you observe offending code, please feel free to send a pull request. |
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
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
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