How to develop?

[lucashueda]

[UPDATED 22/02/2022]

Here I'll give some instructions of how to better work in this forked repository in terms of development.

Main branch

In order to keep the main branch only to update new releases, we keep this branch as original. Our modifications will be on "Unicamp" branch.

Unicamp branch

This is our main branch. It will act like a master branch in terms of, any changes or new modules developments must be done in specific dev branchs. All consistent developments will be merged on Unicamp branch.

Over the time, we should update the Unicamp branch with the latest releases of the original master-branch.

Dev branches

Any modifications must be done in dev branches. So to do this, create a new branch with name "unicampdev_{title}", where the title means what are you developing. Example:

"unicampdev_normalizing_flows" would be the name of a branch where you are programming norm flows modules. So:

In git bash or terminal, create this new branch:

git checkout -b unicampdev_normalizing_flows # Create and move to the new branch

git push --set-upstream origin unicampdev_normalizing_flows #Push to the repository the new branch

Then you will create and move to this new branch. After finishing all yout development, then you must go to 'unicamp' branch and merge:

git checkout unicamp # Move to unicamp branch

git merge unicampdev_normalizing_flows # Merge changes in unicampdev to the unicamp branch

git branch -d unicampdev_normalizing_flows # Delete locally the unicampdev branch

git push origin --delete unicampdev_normalizing_flows # Delete in the repository

To keep in mind while programming

Avoid editing original files, it should create inconsistent merges. Try to create new files for any new module created. And never forget to keep the best practices of git usage, commit and push all changes