Pull Request

GUIDELINE FOR PR:

Here are few things to check before creating a PR, then when you are working on new features to add to your main (production) branch through merge and finally after merging PR:

1. First create an issue -> "issues" tab -> write an issue for your task

1. Create a new branch and start coding

$ git checkout -b dev1

1. Push changes to the respective branch

$ git add <files>
$ git commit -m "useful msg"
$ git push origin dev1

1. When done with all coding and ready to push to production -> Create a pull request (PR)

1. You can still continue to code and push changes to your branch after creating PR until the PR is merged by you

2. To include a brief code prefix such as "ENH:" in step 1, please refer to the end of this documentation here. Step 3 involves adding reviewers for the code review, and in step 4, linking the issue under "Development". Upon approval of the code review, proceed to step 5 and merge the PR.

1. Delete branch on PR

1. Go to your local repo on your laptop -> switch to main branch -> pull new changes that is now on your main (production) branch on remote repo to your local repo -> then delete the same branch locally

$ git checkout main
$ git pull origin main
$ git branch -d dev1

Short Codes Prefixes:

• API: an (incompatible) API change

• BLD: change related to building numpy

• BUG: bug fix DEP: deprecate something, or remove a deprecated object

• DEV: development tool or utility

• DOC: documentation

• ENH: enhancement

• MAINT: maintenance commit (refactoring, typos, etc.)

• REV: revert an earlier commit

• STY: style fix (whitespace, PEP8)

• TST: addition or modification of tests

• REL: related to releasing numpy