This is an automated email from the ASF dual-hosted git repository.
lide pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 2ab825d add contributing.md to Documents
2ab825d is described below
commit 2ab825daf8257f2452887f42fef0fd98edd36ca4
Author: lide <l...@baidu.com>
AuthorDate: Thu Nov 1 10:24:40 2018 +0800
add contributing.md to Documents
---
pages/guides/contributing.md | 158 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 158 insertions(+)
diff --git a/pages/guides/contributing.md b/pages/guides/contributing.md
new file mode 100644
index 0000000..536cc23
--- /dev/null
+++ b/pages/guides/contributing.md
@@ -0,0 +1,158 @@
+title=Contributing
+date=2018-11-01
+type=guide
+status=published
+~~~~~~
+
+<!--Licensed 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.-->
+
+
+# Contributing to Apache Doris (incubating)
+
+Thanks for your interest in contributing.
+As you see from [GitHub] (https://github.com/apache/incubator-doris), Apache
Doris (incubating)’s codebase consists of two parts: frontend (FE) which
written in JAVA and backend (BE) which writte in C++.
+
+## How to contribute?
+
+Most of the contributions that we receive are code contributions, but you can
+also contribute to the documentation or simply report solid bugs
+for us to fix.
+
+When you contribute code, you affirm that the contribution is your original
work and that you license the work to the project under the project’s open
source license. Whether or not you state this explicitly, by submitting any
copyrighted material via pull request, email, or other means you agree to
license the material under the project’s open source license and warrant that
you have the legal authority to do so.
+
+## GitHub Workflow
+
+1. Fork the apache/incubator-doris repository into your GitHub account
+
+ <https://github.com/apache/incubator-doris/fork>
+
+1. Clone your fork of the GitHub repository
+
+ ```sh
+ git clone g...@github.com:<username>/doris.git
+ ```
+
+ replace `<username>` with your GitHub username.
+
+1. Add a remote to keep up with upstream changes
+
+ ```
+ git remote add upstream https://github.com/apache/incubator-doris.git
+ ```
+
+ If you already have a copy, fetch upstream changes
+
+ ```
+ git fetch upstream master
+ ```
+
+1. Create a feature branch to work in
+
+ ```
+ git checkout -b feature-xxx remotes/upstream/master
+ ```
+
+1. _Before submitting a pull request_ periodically rebase your changes
+ (but don't do it when a pull request is already submitted)
+
+ ```
+ git pull --rebase upstream master
+ ```
+
+1. Before submitting a pull request, combine ("squash") related commits into a
single one
+
+ ```
+ git rebase upstream/master
+ ```
+
+1. Submit a pull-request
+
+ ```
+ git push origin feature-xxx
+ ```
+
+ Go to your Doris fork main page
+
+ ```
+ https://github.com/<username>/doris
+ ```
+
+ If you recently pushed your changes GitHub will automatically pop up a
+ `Compare & pull request` button for any branches you recently pushed to.
If you
+ click that button it will automatically offer you to submit your
pull-request
+ to the apache/incubator-doris repository.
+
+ - Give your pull-request a meaningful title.
+ - In the description, explain your changes and the problem they are
solving.
+
+1. Addressing code review comments
+
+ Address code review comments by committing changes and pushing them to
your feature
+ branch.
+
+ ```
+ git push origin feature-xxx
+ ```
+
+### If your pull request shows conflicts with master
+ If your pull request shows conflicts with master, merge master into your
feature branch:
+
+
+ ```
+ git merge upstream/master
+ ```
+
+ and resolve the conflicts. After resolving conflicts, push your branch again:
+
+ ```
+ git push origin feature-xxx
+ ```
+
+ _Avoid rebasing and force pushes after submitting a pull request,_ since
these make it
+ difficult for reviewers to see what you've changed in response to their
reviews. The Doris
+ committer that merges your change will rebase and squash it into a single
commit before
+ committing it to master.
+
+## How to report a bug?
+
+* **Ensure the bug was not already reported** by searching on GitHub under
[Issues](https://github.com/apache/incubator-doris/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new
one](https://github.com/apache/incubator-doris/issues/new). Be sure to include
a **title and clear description**, as much relevant information as possible,
and a **code sample** or an **executable test case** demonstrating the expected
behavior that is not occurring.
+
+
+## How to add a new feature or change an existing one
+
+_Before making any significant changes, please [open an
issue](https://github.com/apache/incubator-doris/issues)._ Discussing your
proposed changes ahead of time will make the contribution process smooth for
everyone.
+
+Once we've discussed your changes and you've got your code ready, make sure
that tests are passing and open your pull request. Your PR is most likely to be
accepted if it:
+
+* Update the README.md with details of changes to the interface.
+* Includes tests for new functionality.
+* References the original issue in description, e.g. "Resolves #123".
+* Has a good commit message: (refer to
<https://chris.beams.io/posts/git-commit/>)
+
+1. Separate subject from body with a blank line
+1. Limit the subject line to 50 characters
+1. Capitalize the subject line
+1. Do not end the subject line with a period
+1. Use the imperative mood in the subject line
+1. Wrap the body at 72 characters
+1. Use the body to explain what and why vs. how
+
+## Contact US
+
+1. Development maillist: <d...@doris.apache.org>
+1. Website: <http://doris.apache.org>
+1. CodeBase: <https://github.com/apache/incubator-doris>
+
+Subscribe to the dev list d...@doris.apache.org. You do that by sending mail
to dev-subscr...@doris.apache.org.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
