"Fossies" - the Fresh Open Source Software Archive

Member "cells-2.3.6/CONTRIBUTING.md" (15 Sep 2021, 6130 Bytes) of package /linux/misc/pydio-cells-2.3.6.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

Contributing to Pydio Cells

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:

Report an issue

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:

Remember: the more info you give, the more easily we can reproduce the bug, the quicker we can fix it.

Code conventions

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.

In addition:

Logging

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.

log.Logger(ctx).Debug("A summary message for action on node "+node.Path, zap.Any("<a predefined id>", node))...
log.Logger(ctx).Debug ...
// rather than
log.Logger(context.Background()).Debug...

Comments

Tests

Note that PRs that do not provide relevant passing tests will be rejected.

Pull Request Workflow

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:

Setup your Pydio Cells Github Repository

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

Set up git remote as upstream

cd $GOPATH/src/github.com/pydio/cells
git remote add upstream https://github.com/pydio/cells
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 Pydio Cells changes

After your code changes, make sure

Commit changes

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 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.

Attribution

The Pull Request HowTo is adapted from minio's great Contributing Page.