gearpump-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From whjiang <...@git.apache.org>
Subject [GitHub] incubator-gearpump pull request: gearpump-34 update developer docu...
Date Sun, 17 Apr 2016 14:07:36 GMT
Github user whjiang commented on a diff in the pull request:

    https://github.com/apache/incubator-gearpump/pull/1#discussion_r59985062
  
    --- Diff: CONTRIBUTING.md ---
    @@ -1,41 +1,125 @@
    -This documents are for committers which have direct write permission to intel-hadoop/gearpump
    +# Developer documentation
     
    -Commit Guideline
    -========================
    -1.	For all commit(except doc), must create an issue id.
    -2.	For all commit log message, must contain the issue id, Like this: fix #issueId, comments.
    -3.	For all PR, the title must contains issue Id.
    -4.	We use rebase and squash instead of merge to ensure the log message is clean. Check
section "Pull Request merge process for Gearpump"
    -5.	Every commit (except doc) must have 1 guy to review before commit.
    +This document summarizes the information relevant to Gearpump committers and contributors.
 It includes information about
    +the development processes and policies as well as the tools we use to facilitate those.
     
    -Pull Request merge process for Gearpump
    -========================
    -1. Fork in github to create a /gearpump repo. After fork, you will have a new repo at
http://github.com/<git-user_id>/gearpump.
    -2. Add gearpump/gearpump as an external repo 'upstream' by following the [guide](https://help.github.com/articles/configuring-a-remote-for-a-fork/).
    +---
     
    -  ```bash
    -  git remote add upstream https://github.com/gearpump/gearpump.git
    -  ```
    +Table of Contents
    +* <a href="#welcome">Welcome!</a>
    +* <a href="#workflow">Contribution workflow</a>
    +    * <a href="#report-bug">Report a bug</a>
    +    * <a href="#request-feature">Request a new feature</a>
    +    * <a href="#contribute-code">Contribute code/document by creating a Pull Request</a>
    +    * <a href="code-review">Code Review</a>
    +* <a href="#build-and-test">Build the code and run the tests</a>
    +    * <a href="#local-copy">Make a local copy of Gearpump</a>
    +    * <a href="#build">How to build</a>
    +    * <a href="#test">How to test</a>
    +    * <a href="#build-doc">How to build document</a>
    +    * <a href="#IDE-setup">IDE setup</a>
    +    * <a href="#code-style">Code style</a>
    +    * <a href="#write-unittest">How to write unit test</a>
    +    * <a href="#write-integrationtest">How to write integration test</a>
    +    * <a href="#write-doc">How to write document</a>
    +* <a href="#committer-work">Committer section</a>
    +    * <a href="#approve-pull-request">Approve a pull request</a>
    +    * <a href="#merge-pull-request">Merge a pull request or patch</a>
    +    * <a href="#release">How to make a release</a>    
     
    -3. In local master branch, periodically sync the forked master with the main master with

    - 
    -  ```
    -   git pull --rebase upstream  master
    -   git push origin master
    -  ``` 
    -No work should ever be done in the forked master. Another way to do this is to 
    +---
     
    - ```
    - git checkout master
    - git fetch upstream
    - git rebase upstream/master
    - ```
    +<a name="welcome"></a>
    +
    +# Welcome!
    +
    +If you are reading this document then you are interested in contributing to the Gearpump
project -- many thanks for that!
    +All contributions are welcome: ideas, documentation, code, patches, bug reports, feature
requests, etc. 
    +
    +
    +<a name="workflow"></a>
    +# Contribution workflow
    +
    +This section explains how to make a contribution. 
    +
    +
    +<a name="report-bug"></a>
    +
    +## Report a bug
    +
    +To report a bug you should [open an issue](https://issues.apache.org/jira/browse/GEARPUMP)
in our issue tracker that
    +summarizes the bug.  Set the form field "Issue type" to "Bug".  If you have not used
the issue tracker before you will
    +need to register an account (free), log in, and then click on the blue "Create Issue"
button in the top navigation bar.
    +
    +In order to help us understand and fix the bug it would be great if you could provide
us with:
    +
    +1. The steps to reproduce the bug.  This includes information about e.g. the Gearpump
version you were using, the deployment model, etc.
    +2. The expected behavior.
    +3. The actual, incorrect behavior.
    +
    +Feel free to search the issue tracker for existing issues (aka tickets) that already
describe the problem;  if there is
    +such a ticket please add your information as a comment.
    +
    +**If you want to provide a patch along with your bug report:**
    +That is great!  In this case please send us a pull request as described in section [Create
a pull request](#create-pr) below.
    +You can also opt to attach a patch file to the issue ticket, but we prefer pull requests
because they are easier to work
    +with.
    +
    +
    +<a name="request-feature"></a>
    +
    +## Request a new feature
     
    -4. Create a working branch
    +To request a new feature you should [open an issue](https://issues.apache.org/jira/browse/GEARPUMP)
in our issue tracker
    +and summarize the desired functionality.  Set the form field "Issue type" to "New feature".
 If you have not used the
    --- End diff --
    
    these sections are borrowed from Storm guide. I am not sure whether we want to have all
these assignable by contributor or we shall adjust it later by committers?
    
    And I prefer to let committer adjust the "Priority" field instead of committer. 


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message