You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mnemonic.apache.org by ga...@apache.org on 2017/07/17 23:07:20 UTC
incubator-mnemonic-site git commit: MNEMONIC-306: Add a page about
how to submit changes
Repository: incubator-mnemonic-site
Updated Branches:
refs/heads/master 45940c5ae -> 6bb476444
MNEMONIC-306: Add a page about how to submit changes
Project: http://git-wip-us.apache.org/repos/asf/incubator-mnemonic-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mnemonic-site/commit/6bb47644
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mnemonic-site/tree/6bb47644
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mnemonic-site/diff/6bb47644
Branch: refs/heads/master
Commit: 6bb4764443c6d01e3ed34442af570b6c1c032abd
Parents: 45940c5
Author: Wang, Gang(Gary) <ga...@intel.com>
Authored: Mon Jul 17 16:06:18 2017 -0700
Committer: Wang, Gang(Gary) <ga...@intel.com>
Committed: Mon Jul 17 16:06:18 2017 -0700
----------------------------------------------------------------------
src/_data/docs.yml | 1 +
src/_docs/submitchanges.md | 43 +++++++++++++++++++++++++++++++++++++++++
2 files changed, 44 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mnemonic-site/blob/6bb47644/src/_data/docs.yml
----------------------------------------------------------------------
diff --git a/src/_data/docs.yml b/src/_data/docs.yml
index f7d77e9..d7d8b38 100644
--- a/src/_data/docs.yml
+++ b/src/_data/docs.yml
@@ -11,6 +11,7 @@
- title: Usage
docs:
- devsetup
+ - submitchanges
- build
- usage
- runtest
http://git-wip-us.apache.org/repos/asf/incubator-mnemonic-site/blob/6bb47644/src/_docs/submitchanges.md
----------------------------------------------------------------------
diff --git a/src/_docs/submitchanges.md b/src/_docs/submitchanges.md
new file mode 100644
index 0000000..6f79638
--- /dev/null
+++ b/src/_docs/submitchanges.md
@@ -0,0 +1,43 @@
+---
+layout: docs
+title: Submit Changes
+permalink: /docs/submitchanges.html
+---
+
+After [Development Setup](devsetup.html), you can follow the steps below to
+submit your code/comments and document changes.
+
+* Make sure the changes are linked to your [Apache JIRA](https://issues.apache.org/jira/projects/MNEMONIC){:target="_blank"} ticket
+* Review your changes according to the JIRA ticket in question
+* Building project in the Docker container
+```bash
+ # cd /ws/incubator-mnemonic
+ # mvn clean install
+```
+* Resolve any problems found by building process
+* Run your test cases specific to your changes, please refer to bin/test.conf
+* Resolve any problems found by your test cases
+* Add your test cases to *bin/test.conf*
+* Commit the changes to your local repository in IDE<br/>
+ for Intellij IDEA, please refer to [Committing Changes to a Local Git Repository](https://www.jetbrains.com/help/idea/committing-changes-to-a-local-git-repository.html){:target="_blank"}<br/>
+ Please use JIRA id and title to fill up the comment of commit<br/>
+ for example
+```
+ MNEMONIC-301: Improve the documentation of architecture page
+```
+* Run all test cases if your changes could impact existing functionalities<br/>
+Note: Please make sure enough available space for test data generation (>30G)
+```bash
+ # cd /ws/incubator-mnemonic
+ # bin/runall.sh
+```
+* Resolve any problems found by test cases and then **amend** your previous commit in IDE<br/>
+ for Intellij IDEA, please refer to [Committing Changes to a Local Git Repository](https://www.jetbrains.com/help/idea/committing-changes-to-a-local-git-repository.html){:target="_blank"}
+* Make sure there is only 1 local commit for each JIRA ticket, otherwise please squash them into one
+* Rebase your codebase before pushing local commits to your remote repository
+ 1. fetch update from remote [Fetching Changes](https://www.jetbrains.com/help/idea/fetching-changes-from-a-remote-git-repository.html){:target="_blank"}
+ 2. Rebase your changes onto upstream/master [Rebasing Branches](https://www.jetbrains.com/help/idea/rebasing-branches.html){:target="_blank"}
+* Push local commits to your remote repository [Pushing Changes](https://www.jetbrains.com/help/idea/pushing-changes-to-the-upstream-git-push.html){:target="_blank"}
+* Create a PR in Github [Creating a pull request](https://help.github.com/articles/creating-a-pull-request/){:target="_blank"}
+* Fix any issues come from community review
+* Change the JIRA ticket status to RESOLVED if the button exists