This is an automated email from the ASF dual-hosted git repository.
liuxun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new 5ec4cff SUBMARINE-475. Add How to commit doc.
5ec4cff is described below
commit 5ec4cff340b90191853f95167753e8cce359107a
Author: Wei-Chiu Chuang <[email protected]>
AuthorDate: Mon Apr 20 17:07:40 2020 -0700
SUBMARINE-475. Add How to commit doc.
### What is this PR for?
Add a doc for new committers what to do to commit other's PR.
### What type of PR is it?
Documentation
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-475
Author: Wei-Chiu Chuang <[email protected]>
Closes #268 from jojochuang/SUBMARINE-475 and squashes the following
commits:
687007e [Wei-Chiu Chuang] Add How to commit doc.
---
docs/community/HowToCommit.md | 78 +++++++++++++++++++++++++++++++++++++++++++
docs/community/README.md | 12 ++++---
2 files changed, 86 insertions(+), 4 deletions(-)
diff --git a/docs/community/HowToCommit.md b/docs/community/HowToCommit.md
new file mode 100644
index 0000000..143e6bc
--- /dev/null
+++ b/docs/community/HowToCommit.md
@@ -0,0 +1,78 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+# Guide for Apache Submarine Committers
+
+This page contains Hadoop Core-specific guidelines for committers.
+
+## New committers
+New committers are encouraged to first read Apache's generic committer
documentation:
+
+* [Apache New Committer
Guide](http://www.apache.org/dev/new-committers-guide.html)
+* [Apache Committer FAQ](http://www.apache.org/dev/committers.html)
+
+The first act of a new core committer is typically to add their name to the
+credits page. This requires changing the site source in
+https://github.com/apache/submarine-site/blob/master/community/member.md. Once
done,
+update the Submarine website as described
+[here](https://github.com/apache/submarine-site/blob/asf-site/README.md)
+(TLDR; don't forget to regenerate the site with hugo, and commit the generated
+results, too).
+
+## Review
+Submarine committers should, as often as possible, attempt to review patches
+submitted by others. Ideally every submitted patch will get reviewed by a
+committer within a few days. If a committer reviews a patch they've not
+authored, and believe it to be of sufficient quality, then they can commit the
+patch, otherwise the patch should be cancelled with a clear explanation for why
+it was rejected.
+
+The list of submitted patches can be found in the GitHub
+[Pull Requests](https://github.com/apache/submarine/pulls) page.
+Committers should scan the list from top-to-bottom,
+looking for patches that they feel qualified to review and possibly commit.
+
+For non-trivial changes, it is best to get another committer to review &
approve
+your own patches before commit.
+
+## Reject
+Patches should be rejected which do not adhere to the guidelines in
+[Contribution Guidelines](contributing.md). Committers should always be
+polite to contributors and try to instruct and encourage them to contribute
+better patches. If a committer wishes to improve an unacceptable patch, then it
+should first be rejected, and a new patch should be attached by the committer
+for review.
+
+## Commit individual patches
+Submarine uses git for source code version control. The writable repo is at -
+https://gitbox.apache.org/repos/asf/submarine.git
+
+It is strongly recommended to use the cicd script to merge the PRs.
+See the instructions at
+https://github.com/apache/submarine/tree/master/dev-support/cicd
+
+## Adding Contributors role
+There are three roles (Administrators, Committers, Contributors) in the
project.
+
+* Contributors who have Contributors role can become assignee of the issues in
the project.
+* Committers who have Committers role can set arbitrary roles in addition to
Contributors role.
+* Committers who have Administrators role can edit or delete all comments, or
even delete issues in addition to Committers role.
+
+How to set roles
+
+1. Login to ASF JIRA
+2. Go to the project page (e.g.
https://issues.apache.org/jira/browse/SUBMARINE )
+3. Hit "Administration" tab
+4. Hit "Roles" tab in left side
+5. Add Administrators/Committers/Contributors role
diff --git a/docs/community/README.md b/docs/community/README.md
index 0cf9b37..160e9ee 100644
--- a/docs/community/README.md
+++ b/docs/community/README.md
@@ -20,7 +20,7 @@ Your journey of becoming a contributor and committer starts
from here: improving
## Communicating
-You can reach out to the community members via any one of the following ways:
+You can reach out to the community members via any one of the following ways:
+ Slack Developer:
[https://the-asf.slack.com/submarine-dev/](https://the-asf.slack.com/submarine-dev/)
@@ -32,9 +32,9 @@ You can reach out to the community members via any one of the
following ways:
## Your First Contribution
-You can start by finding an existing issue with the
[https://issues.apache.org/jira/projects/SUBMARINE/issues/SUBMARINE?filter=allopenissues](https://issues.apache.org/jira/projects/SUBMARINE/issues/SUBMARINE?filter=allopenissues)
label. These issues are well suited for new contributors.
+You can start by finding an existing issue with the
[https://issues.apache.org/jira/projects/SUBMARINE/issues/SUBMARINE?filter=allopenissues](https://issues.apache.org/jira/projects/SUBMARINE/issues/SUBMARINE?filter=allopenissues)
label. These issues are well suited for new contributors.
-If a PR (Pull Request) submitted to the [Submarine
Github](https://github.com/apache/submarine) projects by you is approved and
merged, then you become a Submarine Contributor.
+If a PR (Pull Request) submitted to the [Submarine
Github](https://github.com/apache/submarine) projects by you is approved and
merged, then you become a Submarine Contributor.
If you want to work on a new idea of relatively small scope:
@@ -42,7 +42,7 @@ If you want to work on a new idea of relatively small scope:
2. The repo owners will respond to your issue promptly.
-3. Submit a [pull request of Submarine](https://github.com/apache/submarine)
containing a tested change.
+3. Submit a [pull request of Submarine](https://github.com/apache/submarine)
containing a tested change.
Once you become a contributor of Apache Submarine, check your name here:
[CONTRIBUTORS](contributors.md)
@@ -58,6 +58,10 @@ Note that becoming a committer is not just about submitting
some patches; it‘s
See [Become a Committer.md](become-a-committer.md) for steps of becoming a
committer and more details.
+## How to commit
+
+See [How to commit](HowToCommit.md) for helper doc for Submarine committers.
+
## Communication
Communication within the Submarine community abides by [Apache’s Code of
Conduct](https://www.apache.org/foundation/policies/conduct.html).
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
