Add CONTRIBUTING.md (#161)
* docs: add CONTRIBUTING.md Signed-off-by: Gaius <gaius.qi@gmail.com>
This commit is contained in:
Gaius
parent
dc4f2f6e12
commit
6c594a884b
|
|
@ -0,0 +1,236 @@
|
||||||
|
# Contributing to Dragonfly2
|
||||||
|
|
||||||
|
It is warmly welcomed if you have interest to hack on Dragonfly2. First, we encourage this kind of willing very much. And here is a list of contributing guide for you.
|
||||||
|
|
||||||
|
## Topics
|
||||||
|
|
||||||
|
* [Reporting security issues](#reporting-security-issues)
|
||||||
|
* [Reporting general issues](#reporting-general-issues)
|
||||||
|
* [Code and doc contribution](#code-and-doc-contribution)
|
||||||
|
* [Engage to help anything](#engage-to-help-anything)
|
||||||
|
* [Join Dragonfly2 as a member](#join-dragonfly2-as-a-member)
|
||||||
|
|
||||||
|
## Reporting security issues
|
||||||
|
|
||||||
|
Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of Dragonfly2, please do not discuss it in public and even do not open a public issue. Instead we encourage you to send us a private email to [Dragonfly2@noreply.github.com](mailto:Dragonfly2@noreply.github.com) to report this.
|
||||||
|
|
||||||
|
## Reporting general issues
|
||||||
|
|
||||||
|
To be honest, we regard every user of Dragonfly2 as a very kind contributor. After experiencing Dragonfly2, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/dragonflyoss/Dragonfly2/issues/new).
|
||||||
|
|
||||||
|
Since we collaborate project Dragonfly2 in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.
|
||||||
|
|
||||||
|
To make the issue details as standard as possible, we setup an [ISSUE TEMPLATE](./.github/ISSUE_TEMPLATE) for issue reporters. You can find three kinds of issue templates there: question, bug report and feature request. Please **BE SURE** to follow the instructions to fill fields in template.
|
||||||
|
|
||||||
|
There are lot of cases when you could open an issue:
|
||||||
|
|
||||||
|
* bug report
|
||||||
|
* feature request
|
||||||
|
* performance issues
|
||||||
|
* feature proposal
|
||||||
|
* feature design
|
||||||
|
* help wanted
|
||||||
|
* doc incomplete
|
||||||
|
* test improvement
|
||||||
|
* any questions on project
|
||||||
|
* and so on
|
||||||
|
|
||||||
|
Also we must remind that when filing a new issue, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on.
|
||||||
|
|
||||||
|
## Code and doc contribution
|
||||||
|
|
||||||
|
Every action to make project Dragonfly2 better is encouraged. On GitHub, every improvement for Dragonfly2 could be via a PR (short for pull request).
|
||||||
|
|
||||||
|
* If you find a typo, try to fix it!
|
||||||
|
* If you find a bug, try to fix it!
|
||||||
|
* If you find some redundant codes, try to remove them!
|
||||||
|
* If you find some test cases missing, try to add them!
|
||||||
|
* If you could enhance a feature, please **DO NOT** hesitate!
|
||||||
|
* If you find code implicit, try to add comments to make it clear!
|
||||||
|
* If you find code ugly, try to refactor that!
|
||||||
|
* If you can help to improve documents, it could not be better!
|
||||||
|
* If you find document incorrect, just do it and fix that!
|
||||||
|
* ...
|
||||||
|
|
||||||
|
Actually it is impossible to list them completely. Just remember one princinple:
|
||||||
|
|
||||||
|
> WE ARE LOOKING FORWARD TO ANY PR FROM YOU.
|
||||||
|
|
||||||
|
Since you are ready to improve Dragonfly2 with a PR, we suggest you could take a look at the PR rules here.
|
||||||
|
|
||||||
|
* [Workspace Preparation](#workspace-preparation)
|
||||||
|
* [Branch Definition](#branch-definition)
|
||||||
|
* [Commit Rules](#commit-rules)
|
||||||
|
* [PR Description](#pr-description)
|
||||||
|
* [Developing Environment](#developing-environment)
|
||||||
|
* [Golang Dependency Management](#golang-dependency-management)
|
||||||
|
|
||||||
|
### Workspace Preparation
|
||||||
|
|
||||||
|
To put forward a PR, we assume you have registered a GitHub ID. Then you could finish the preparation in the following steps:
|
||||||
|
|
||||||
|
1. **FORK** Dragonfly2 to your repository. To make this work, you just need to click the button Fork in right-left of [dragonflyoss/Dragonfly2](https://github.com/dragonflyoss/Dragonfly2) main page. Then you will end up with your repository in `https://github.com/<your-username>/Dragonfly`, in which `your-username` is your GitHub username.
|
||||||
|
1. **CLONE** your own repository to develop locally. Use `git clone https://github.com/<your-username>/Dragonfly2.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
|
||||||
|
|
||||||
|
1. **Set Remote** upstream to be `https://github.com/dragonflyoss/Dragonfly2.git` using the following two commands:
|
||||||
|
|
||||||
|
```
|
||||||
|
git remote add upstream https://github.com/dragonflyoss/Dragonfly2.git
|
||||||
|
git remote set-url --push upstream no-pushing
|
||||||
|
```
|
||||||
|
|
||||||
|
With this remote setting, you can check your git remote configuration like this:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ git remote -v
|
||||||
|
origin https://github.com/<your-username>/Dragonfly2.git (fetch)
|
||||||
|
origin https://github.com/<your-username>/Dragonfly2.git (push)
|
||||||
|
upstream https://github.com/dragonflyoss/Dragonfly2.git (fetch)
|
||||||
|
upstream no-pushing (push)
|
||||||
|
```
|
||||||
|
|
||||||
|
Adding this, we can easily synchronize local branches with upstream branches.
|
||||||
|
|
||||||
|
1. **Create a branch** to add a new feature or fix issues
|
||||||
|
|
||||||
|
Update local working directory:
|
||||||
|
|
||||||
|
```
|
||||||
|
cd Dragonfly2
|
||||||
|
git fetch upstream
|
||||||
|
git checkout main
|
||||||
|
git rebase upstream/main
|
||||||
|
```
|
||||||
|
|
||||||
|
Create a new branch:
|
||||||
|
|
||||||
|
```
|
||||||
|
git checkout -b <new-branch>
|
||||||
|
```
|
||||||
|
|
||||||
|
Make any change on the `new-branch` then build and test your codes.
|
||||||
|
|
||||||
|
### Branch Definition
|
||||||
|
|
||||||
|
Right now we assume every contribution via pull request is for [branch main](https://github.com/dragonflyoss/Dragonfly2/tree/main) in Dragonfly2. Before contributing, be aware of branch definition would help a lot.
|
||||||
|
|
||||||
|
As a contributor, keep in mind again that every contribution via pull request is for branch main. While in project Dragonfly2, there are several other branches, we generally call them rc branches, release branches and backport branches.
|
||||||
|
|
||||||
|
Before officially releasing a version, we will checkout a rc(release candidate) branch. In this branch, we will test more than branch main.
|
||||||
|
|
||||||
|
When officially releasing a version, there will be a release branch before tagging. After tagging, we will delete the release branch.
|
||||||
|
|
||||||
|
When backporting some fixes to existing released version, we will checkout backport branches. After backporting, the backporting effects will be in PATCH number in MAJOR.MINOR.PATCH of [SemVer](http://semver.org/).
|
||||||
|
|
||||||
|
### Commit Rules
|
||||||
|
|
||||||
|
Actually in Dragonfly2, we take two rules serious when committing:
|
||||||
|
|
||||||
|
* [Commit Message](#commit-message)
|
||||||
|
* [Commit Content](#commit-content)
|
||||||
|
|
||||||
|
#### Commit Message
|
||||||
|
|
||||||
|
Commit message could help reviewers better understand what the purpose of submitted PR is. It could help accelerate the code review procedure as well. We encourage contributors to use **EXPLICIT** commit message rather than ambiguous message. In general, we advocate the following commit message type:
|
||||||
|
|
||||||
|
* docs: xxxx. For example, "docs: add docs about storage installation".
|
||||||
|
* feature: xxxx.For example, "feature: make result show in sorted order".
|
||||||
|
* bugfix: xxxx. For example, "bugfix: fix panic when input nil parameter".
|
||||||
|
* style: xxxx. For example, "style: format the code style of Constants.java".
|
||||||
|
* refactor: xxxx. For example, "refactor: simplify to make codes more readable".
|
||||||
|
* test: xxx. For example, "test: add unit test case for func InsertIntoArray".
|
||||||
|
* chore: xxx. For example, "chore: integrate travis-ci". It's the type of mantainance change.
|
||||||
|
* other readable and explicit expression ways.
|
||||||
|
|
||||||
|
On the other side, we discourage contributors from committing message like the following ways:
|
||||||
|
|
||||||
|
* ~~fix bug~~
|
||||||
|
* ~~update~~
|
||||||
|
* ~~add doc~~
|
||||||
|
|
||||||
|
#### Commit Content
|
||||||
|
|
||||||
|
Commit content represents all content changes included in one commit. We had better include things in one single commit which could support reviewer's complete review without any other commits' help. In another word, contents in one single commit can pass the CI to avoid code mess. In brief, there are two minor rules for us to keep in mind:
|
||||||
|
|
||||||
|
* avoid very large change in a commit;
|
||||||
|
* complete and reviewable for each commit.
|
||||||
|
|
||||||
|
No matter what the commit message, or commit content is, we do take more emphasis on code review.
|
||||||
|
|
||||||
|
### PR Description
|
||||||
|
|
||||||
|
PR is the only way to make change to Dragonfly2 project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](./.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request.
|
||||||
|
|
||||||
|
### Developing Environment
|
||||||
|
|
||||||
|
As a contributor, if you want to make any contribution to Dragonfly2 project, we should reach an agreement on the version of tools used in the development environment.
|
||||||
|
Here are some dependents with specific version:
|
||||||
|
|
||||||
|
* golang : v1.15
|
||||||
|
* misspell : latest
|
||||||
|
* shellCheck : latest
|
||||||
|
* docker: latest
|
||||||
|
|
||||||
|
When you develop the Dragonfly2 project at the local environment, you should use subcommands of Makefile to help yourself to check and build the latest version of Dragonfly2. For the convenience of developers, we use the docker to build Dragonfly2. It can reduce problems of the developing environment.
|
||||||
|
|
||||||
|
### Golang Dependency Management
|
||||||
|
|
||||||
|
The Dragonfly2 project uses [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage dependencies on external packages. This requires a working Go environment with version 1.15 or greater installed.
|
||||||
|
|
||||||
|
To add or update a new dependency, use the `go get` command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Pick the latest tagged release.
|
||||||
|
go get example.com/some/module/pkg
|
||||||
|
|
||||||
|
# Pick a specific version.
|
||||||
|
go get example.com/some/module/pkg@vX.Y.Z
|
||||||
|
```
|
||||||
|
|
||||||
|
Tidy up the `go.mod` and `go.sum` files:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go mod tidy
|
||||||
|
```
|
||||||
|
|
||||||
|
You have to commit the changes to `go.mod`, `go.sum` before submitting the pull request.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add go.mod go.sum
|
||||||
|
git commit
|
||||||
|
```
|
||||||
|
|
||||||
|
## Engage to help anything
|
||||||
|
|
||||||
|
We choose GitHub as the primary place for Dragonfly2 to collaborate. So the latest updates of Dragonfly2 are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.
|
||||||
|
|
||||||
|
* reply to other's issues if you could;
|
||||||
|
* help solve other user's problems;
|
||||||
|
* help review other's PR design;
|
||||||
|
* help review other's codes in PR;
|
||||||
|
* discuss about Dragonfly2 to make things clearer;
|
||||||
|
* advocate Dragonfly2 technology beyond GitHub;
|
||||||
|
* write blogs on Dragonfly2 and so on.
|
||||||
|
|
||||||
|
In a word, **ANY HELP IS CONTRIBUTION.**
|
||||||
|
|
||||||
|
## Join Dragonfly2 as a member
|
||||||
|
|
||||||
|
It is also welcomed to join Dragonfly2 team if you are willing to participate in Dragonfly2 community continuously and keep active.
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
* Have read the [Contributing to Dragonfly2](CONTRIBUTING.md) carefully
|
||||||
|
* Have read the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md)
|
||||||
|
* Have submitted multi PRs to the community
|
||||||
|
* Be active in the community, may including but not limited
|
||||||
|
* Submitting or commenting on issues
|
||||||
|
* Contributing PRs to the community
|
||||||
|
* Reviewing PRs in the community
|
||||||
|
|
||||||
|
### How to do it
|
||||||
|
|
||||||
|
You can do it in either of two ways:
|
||||||
|
|
||||||
|
* Submit a PR in the [dragonflyoss/Dragonfly2](https://github.com/dragonflyoss/Dragonfly2) repo
|
||||||
|
* Contact with the community's [maintainers](MAINTAINERS.md) offline
|
||||||
|
|
@ -1,9 +0,0 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<module type="WEB_MODULE" version="4">
|
|
||||||
<component name="NewModuleRootManager" inherit-compiler-output="true">
|
|
||||||
<exclude-output />
|
|
||||||
<content url="file://$MODULE_DIR$" />
|
|
||||||
<orderEntry type="inheritedJdk" />
|
|
||||||
<orderEntry type="sourceFolder" forTests="false" />
|
|
||||||
</component>
|
|
||||||
</module>
|
|
||||||
Loading…
Reference in New Issue