Guidelines for code development!!! (Only if you are the collaborators)

[ZPYin]

code download

git clone https://github.com/ZPYin/Pollynet_Processing_Chain/issues/new
git fetch origin dev:dev   # grab the 'dev' branch for local merge

cd Pollynet_Processing_Chain

code development

1. CREATE your own branch as your own playground git checkout -b {branch_name}
2. Do all your special work under your iwn branch, including add new features, test your features ...
3. Commit/backup your work frequently git add * and git commit
4. Push all your local commit to the remote branch git push origin {branch_name} (it will create a new branch if {branch_name} does not exist.)

code merge

Draft a pull request to the dev branch to inform others that your feature is really to be implemented into the code base.

In the pull request (PR) panel, you should specify (what, why) your PR should be adopted. We will then start the code review and further test within the dev branch. If it works well, we will make it part of dev and will release it in the next big update.

code style

At the beginning, I don't want the developers waste too much time with following certain code style. Just start to write what you want (maybe one rule: don't use Tab to align your code). Coding style is something we can managed after we finished the code development.

But if you want to follow a certain code style, I would recommend the MATLAB coding style and Python coding style PEP8.