Pydio Cells is a free and open source project and we are very glad to welcome your contribution. To make the process as seamless as possible, we recommend you read this contribution guide.
FYI, we use Github only for "qualified bugs" : bugs that are easily reproduced, validated by a Pydio Team member. Our preferred communication channel is our Forum. Please do not ask question in github issues, nor in Twitter or other social feed.
So, what should I do in case of:
And only if you're invited to:
If you report an issue (either on the forum or upon request by submitting a github issue), make sure to put as much detail as possible:
$ ./cells --log debug startand attach relevant log to your request
Remember: the more info you give, the more easily we can reproduce the bug, the quicker we can fix it.
If you end up coding to contribute a fix or new feature, please read carefully the below rules before jumping to the next paragraph that describes the PR process step by step. We will reject any PR that does not respect these rules.
Generally speaking, we respect the standard code conventions defined in effective Go.
We use zap for logging purpose. Logs are redirected to standard out in development mode and serialized as json and collected by a dedicated service when in production.
.Logger(ctx).Debug("A summary message for action on node "+node.Path, zap.Any("<a predefined id>", node))...log
cells/common/zapfields.go, so that logs are then more easily searchable
.Logger(ctx).Debug ... log// rather than .Logger(context.Background()).Debug...log
log.Logger(ctx).Error("unable to save file")
log.Logger(ctx).Error("Unable to save file")
plugins.go: in case of a
dao.go: where we define this package interfaces
doc.gofile if the correct file is not obvious
Note that PRs that do not provide relevant passing tests will be rejected.
Before submitting a Pull Request, please sign the Contributor License Agreement, then start by forking the Pydio Cells GitHub repository, make changes in a branch and then send a pull request. Below are the steps in details:
Fork Pydio Cells source repository to your own personal repository. Copy the URL of your fork.
mkdir -p $GOPATH/src/github.com/pydio cd $GOPATH/src/github.com/pydio git clone <the URL you just copied> cd pydio
cd $GOPATH/src/github.com/pydio/cells git remote add upstream https://github.com/pydio/cells git fetch upstream git merge upstream/master
Before making code changes, make sure you create a separate branch for these changes
git checkout -b my-new-feature
After your code changes, make sure
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 a cool feature'
Push your locally committed changes to the remote origin (your fork)
git push origin my-new-feature
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.
The Pull Request HowTo is adapted from minio's great Contributing Page.