Skip to content

General notes for working on this repository

redcuillin edited this page Mar 24, 2022 · 4 revisions

Branch structure for working with code:

  • redcuillin_master - Modified version of upstream master_2020 with any changes made to this fork that I want to keep.
  • master_2020 - Kept up to date with upstream. Should not have any code changes or commits made to it, but be used as basis for branches where any code changes that are to be added to pull requests to upstream are made.
  • enhancements/fixes/etc ... should be done in branches created from master_2020 branch. Pull requests should be done from these branches. After merging to upstream, they should also be merged into redcuillin_master branch, forming the most up to date 'personal' version of simple invoices for daily use.

Process for changes requiring a pull request to upstream:

  1. git checkout master_2020. git pull upstream/master_2020 if need be.
  2. Add an 'issue' giving details of changes and reasons.
  3. git branch issuenumberX. So a branch for https://github.com/redcuillin/simpleinvoices/issues/8 would be something like 'issue8' or 'issuenumber8'.
  4. Merge the issue branch into redcuillin_master, so that this branch contains all changes, even if they are not accepted by upstream.
  5. Create pull request to upstream if changes are likely to be beneficial.