Marija Contribution Guide
Marija community welcomes your contribution. To make the process as seamless as possible, we recommend you read this contribution guide.
Start by forking the Marija 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 Marija Github Repository
Fork Marija upstream source repository to your own personal repository. Copy the URL of your Marija fork (you will need it for the
git clone command below).
$ mkdir -p $GOPATH/src/github.com/dutchcoders $ cd $GOPATH/src/github.com/dutchcoders $ git clone <paste saved URL for personal forked marija repo> $ cd marija
Set up git remote as
$ cd $GOPATH/src/github.com/dutchcoders/marija $ git remote add upstream https://github.com/dutchcoders/marija $ 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 Marija server changes
After your code changes, make sure you'll:
- add test cases for the new code.
- squash your commits into a single commit.
git rebase -i. It's okay to force update your pull request.
go test -race ./...and
After verification, commit your changes. This is a great post 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 for detailed steps on how to create a pull request. After a Pull Request gets peer reviewed and approved, it will be merged.
Marija manages dependencies?
Marija manages its dependencies using [dep]. To add a dependency:
To remove a dependency
- Edit your code to not import foo/bar
What are the coding guidelines for Marija?
Marija is fully conformant with Golang style. Refer: Effective Go article from Golang project. If you observe offending code, please feel free to send a pull request.