This is an automated email from the ASF dual-hosted git repository.
klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 4d758a7 docs(community): update docs (#28)
4d758a7 is described below
commit 4d758a777e3b79d5d319b9fcc4740361bc44ff92
Author: warrenchen <[email protected]>
AuthorDate: Thu May 19 15:02:38 2022 +0800
docs(community): update docs (#28)
---
.gitignore | 2 +
community/contributor/_category_.json | 4 +
community/contributor/contributors.md | 9 ++
community/index.md | 49 ++---------
.../{ => make-contribution}/BlogSubmission.md | 0
community/make-contribution/_category_.json | 4 +
.../contributor-growth-program.md | 13 +++
.../make-contribution/development-workflow.md | 98 ++++++++++++++++++++++
8 files changed, 138 insertions(+), 41 deletions(-)
diff --git a/.gitignore b/.gitignore
index b2d6de3..da687a3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,3 +18,5 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*
+.idea
+package-lock.json
diff --git a/community/contributor/_category_.json
b/community/contributor/_category_.json
new file mode 100644
index 0000000..c07fe12
--- /dev/null
+++ b/community/contributor/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Contributors",
+ "position": 3
+}
diff --git a/community/contributor/contributors.md
b/community/contributor/contributors.md
new file mode 100644
index 0000000..a54c6fb
--- /dev/null
+++ b/community/contributor/contributors.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 1
+---
+
+# DevLake Contributors
+
+## New Contributors in 2022 May
+
+
diff --git a/community/index.md b/community/index.md
index f0d3c37..fbbed59 100644
--- a/community/index.md
+++ b/community/index.md
@@ -1,7 +1,7 @@
---
sidebar_position: 01
-title: "How to Make Contribution?"
-linkTitle: "How to Make Contribution?"
+title: "How to Make Contributions?"
+linkTitle: "How to Make Contributions?"
tags: []
categories: []
weight: 10000
@@ -24,47 +24,14 @@ If you intend to change the public API, or make any
non-trivial changes to the i
If you’re only fixing a bug, it’s fine to submit a pull request right away but
we still recommend to file an issue detailing what you’re fixing. This is
helpful in case we don’t accept that specific fix but want to keep track of the
issue.
-## Maintainer team @ Merico
+## Maintainer team
-Dev Lake is maintained by a group of engineers at Merico, led by
[@hezyin](https://github.com/hezyin). We aim to achieve an SLA of 24 hrs for
replying to issues.
+Apache DevLake is maintained by apache/devlake committers. We aim to achieve
an SLA of 24 hrs for replying to issues.
-## Style guides
+## Development workflow
-### Git Commit message
+Please check [Development Workflow](make-contribution/development-workflow.md)
-We follow the [conventional
commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) guidelines.
+## Contributor growth program
-#### Commit tool
-
-We use https://github.com/lintingzhen/commitizen-go to author our commits.
-
-```sh
-make commit
-```
-
-```
-> [email protected] commit /home/code/merico-dev/lake
-> cz
-
[email protected], [email protected]
-
-? Select the type of change that you're committing: (Use arrow keys)
-> feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space,
formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing tests or correcting existing tests
-(Move up and down to reveal more choices)
-? What is the scope of this change (e.g. component or file name): (press enter
to skip)
-? Write a short, imperative tense description of the change (max 93 chars):
- (23) add commit message tool
-? Provide a longer description of the change: (press enter to skip)
-
-? Are there any breaking changes? No
-? Does this change affect any open issues? No
-[chore/commit_message dc34f57] chore: add commit message tool
- 5 files changed, 585 insertions(+), 4 deletions(-)
-```
-<br/><br/><br/>
+Please check [Contributor Growth
Program](make-contribution/contributor-growth-program.md)
\ No newline at end of file
diff --git a/community/BlogSubmission.md
b/community/make-contribution/BlogSubmission.md
similarity index 100%
rename from community/BlogSubmission.md
rename to community/make-contribution/BlogSubmission.md
diff --git a/community/make-contribution/_category_.json
b/community/make-contribution/_category_.json
new file mode 100644
index 0000000..f8600e9
--- /dev/null
+++ b/community/make-contribution/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Making Contributions",
+ "position": 2
+}
diff --git a/community/make-contribution/contributor-growth-program.md
b/community/make-contribution/contributor-growth-program.md
new file mode 100644
index 0000000..57591bb
--- /dev/null
+++ b/community/make-contribution/contributor-growth-program.md
@@ -0,0 +1,13 @@
+# Contributor Growth Program
+
+**Note:** This document is wip and welcomes everyone to help improve.
+
+## DevLake Community Membership
+
+| Role | Responsibilities
| Requirements
| Defined by
|
+|-------------|-----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|-----------------------------------------|
+| Contributor | N/A
| At least 1 contribution to the project
| N/A
|
+| Committer | Active contributor in the community
| Finished a whole plugin, or equal contribution
(e.g contributed 10 `pr`) | DevLake GitHub Org
member & Team member |
+| PPMC | Responsible for the oversight of the podling, and it also
decides who to add as a PPMC member | Highly experienced active member who is
knowledgeable about the codebase; Member for at least 6 month | Apache PMC
|
+
+New contributors should be welcomed to the DevLake community by existing
members, helped with PR workflow, and directed to relevant documentation and
communication channels.
diff --git a/community/make-contribution/development-workflow.md
b/community/make-contribution/development-workflow.md
new file mode 100644
index 0000000..bbd3e48
--- /dev/null
+++ b/community/make-contribution/development-workflow.md
@@ -0,0 +1,98 @@
+# Development Workflow
+
+This document shows the workflow of how to develop DevLake.
+
+## Step 1 - Clone the repo
+
+1. Create your clone locally
+
+```sh
+mkdir -p ${WORKING_PATH}
+cd ${WORKING_PATH}
+# You can also use the url: [email protected]:merico-dev/lake.git
+# if your ssh configuration is proper
+git clone https://github.com/merico-dev/lake.git
+
+cd lake
+
+git remote add upstream https://github.com/apache/incubator-devlake.git
+# Never push to upstream locally
+git remote set-url --push upstream no_push
+```
+
+2. Confirm the remotes you've set is make sense
+
+Execute `git remote -v` and you'll see output like below:
+
+```sh
+origin [email protected]:merico-dev/lake.git (fetch)
+origin [email protected]:merico-dev/lake.git (push)
+upstream https://github.com/apache/incubator-devlake.git (fetch)
+upstream no_push (push)
+```
+
+## Step 2 - Keep your branch in sync
+
+You will often need to update your local code to keep in sync with upstream
+
+```sh
+git fetch upstream
+git checkout main
+git rebase upstream/main
+```
+
+## Step 3 - Coding
+
+First, you need to pull a new branch, the name is according to your own taste.
+
+```sh
+git checkout -b feat-xxx
+```
+
+Then start coding.
+
+## Step 4 - Commit & Push
+
+```sh
+git add <file>
+git commit -s -m "some description here"
+git push -f origin feat-xxx
+```
+
+### Style guides
+
+##### Git Commit message
+
+We follow the [conventional
commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) guidelines.
+
+##### Commit tool
+
+We use https://github.com/lintingzhen/commitizen-go to author our commits.
+
+```
+> git cz
+
[email protected], [email protected]
+
+? Select the type of change that you're committing: (Use arrow keys)
+> feat: A new feature
+ fix: A bug fix
+ docs: Documentation only changes
+ style: Changes that do not affect the meaning of the code (white-space,
formatting, missing semi-colons, etc)
+ refactor: A code change that neither fixes a bug nor adds a feature
+ perf: A code change that improves performance
+ test: Adding missing tests or correcting existing tests
+(Move up and down to reveal more choices)
+? What is the scope of this change (e.g. component or file name): (press enter
to skip)
+? Write a short, imperative tense description of the change (max 93 chars):
+ (23) add commit message tool
+? Provide a longer description of the change: (press enter to skip)
+
+? Are there any breaking changes? No
+? Does this change affect any open issues? No
+[chore/commit_message dc34f57] chore: add commit message tool
+ 5 files changed, 585 insertions(+), 4 deletions(-)
+```
+
+
+Then you can create a `pr` on GitHub.
\ No newline at end of file
