This file serves as the contributors' guidelines for the half_tael_DQN project.
📌 v3.0 | 2019.09.02 | Henry Zhong
As you are contributing to this project, it is assumed that you have your OANDA credentials assigned in oanda_config.py. To protect your privacy and to keep the integrity of this repository, please do:
git update-index --assume-unchanged oanda_config.py
So that git will stop tracking future changes to oanda_config.py.
| Emoji | Use Case | Emoji | Use Case |
|---|---|---|---|
| 🎉 | Initial commit | 📚 | Documentation |
| ✨ | New feature | 💄 | Cosmetic |
| 🔨 | Update | 📡 | Broadcast |
| ♻️ | Refactor | 🔰 | User manual |
| 🚧 | Work in progress | 💡 | Idea |
| 🐛 | Bugfix | 📌 | Version tag |
| 🔒 | Security Enhance | 🚚 | Move path |
| 🐎 | Performance Enhance | 🗑️ | Removal |
| 🚨 | Test | 💩 | Deprecation |
| 📊 | Data | ⏪ | Rewind |
| ⚙️ | Environment | 🔀 | Rebase / Merge |
| ⏲ | Tuning | 📦 | Pack |
| 📈 | Analysis | ✅ ☑️ ❌ ❓ | Review feedback |
If one commit performs multiple tasks, use multiple Emojis with <white space> in between. Also leave a <white space> between the last Emoji and the text of commit message.
Describe your changes in imperative mood, e.g. "make xyzzy do frotz" instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy to do frotz", as if you are giving orders to the codebase to change its behavior. -- SubmittingPatches\Documentation
git checkout master
git checkout -b YourBranch # new branch base on master.
git checkout -b YourBranch v1.0 # new branch base on release tag.
git checkout -b YourBranch ExistedBranch # new branch base on existed branch.
git push origin YourBranch # push YourBranch to repository.
git checkout YourBranch
git add ModifiedFile
git commit -m "Emoji Commit Message"
git push -u origin YourBranch
git checkout YourBranch
git pull origin YourBranch --rebase
From github.com:choH/half_tael_DQN
>> * branch YourBranch -> FETCH_HEAD
>> Already up to date.
>> Current branch YourBranch is up to date.
git rebase master
>> Current branch YourBranch is up to date.
git push origin YourBranch -f
git checkout YourBranch
git pull origin YourBranch --rebase
git rebase master
git status
>> both modified: a_file
atom a_file # or open with any other editor, as long as you resolve the conflict(s).
git add a_file
git rebase --continue
>> If there is nothing left to stage, chances are that something else
>> already introduced the same changes; you might want to skip this patch.
git rebase --skip # If the terminal show no above message, you may skip this comnand.
git push origin YourBranch -f
The usage of git rebase --skip is a bit unintuitive, you may refer this article as an extended reading.
With Section 2.4 or 2.5 done, YourBranch should have all the commits from master before its branch commits
Go on GitHub web interface --> checkin YourBranch --> Click on New pull request besides YourBranch --> Create pull request --> the expand arrow beside Create a merge commit (if applicable) --> Rebase and merge.
The method of rebase has many advantages, but one of its con is it will lose the information regarding which commit you branch was checkout from. Thus, you should title your pull request as:
Rebase <YourBranch> (from <commit hash you checkout from>) onto <BaseBranch> <commit hash you rebase to>.
As mentioned, rebase will it will lose the information regarding which commit you branch was checkout from. Thus, it is recommend to go into comment section of the commit you check out from, and write something like:
Branch [YourBranch](link_to_your_branch) checked out from this commit.
With the usage of rebase, the commit history of this project will be displayed in a linear manner, such as:
start-of-task-A --> A.1 --> A.2 --> A.x --> end-of-task-A --> start-of-task-B --> B.1 --> B.x --> end-of-task-B --> start-of-task-C
But real-life commit history won't have commits like start-of-task-A and end-of-task-A; in fact, it won't even have the A. or B. prefix to help you distinguish which task this commit is working for. Thus, it is recommend to mark out an important accomplishment (usually ganged with issues or even milestones) with an empty commit prefix by 📌.
To write an empty commit message prefixed by 📌:
git commit --allow-empty -m "📌 Your commit message."
p.s. It is usually hard to pin the start of a task as development may lead to a various range of accomplishments. But if you are certain about it, you are more than welcome to pin it — e.g. we push a pin commit before every version release like 📌 v2.0 pre release pin..
Rebase half_tael_v3.0 (from d0d5eac) onto master d0d5eac.
Rebase branch half_tael_v3.0 onto master as milestone half_tael_v3.0: Refactor DQN_v2.5 to work with virtual trading platform accomplished.
Branch half_tael_v3.0 checked out from this commit — a.k.a. half_tale_DQN v2.0: Virtual Trading Platform with DQN v1.0 + DQN v2.5.