Make instructions for commit workflow more clear

rancher · May 14, 2021 · 19c96f7 · 19c96f7
1 parent 44b051e
commit 19c96f7
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/templates/template/packages/README.md b/templates/template/packages/README.md
@@ -100,9 +100,10 @@ To check whether the new packages you are introducing will cause any issues with
   - Note: As part of replacing your dependencies, the Chart.yaml and requirements.yaml are considered "Managed Files". These files are prone to having conflicts and may need to be deleted / recreated on a prepare if there are conflicts. Please open up an issue if you encounter frequent bugs with these files so that we can take a look.
 - Make changes to the relevant working directories
 - Run `PACKAGE=<package> make patch` to save your changes
-- Run `make clean`
-- Run `make charts` to test your changes by committing the generated directories and pushing it to a branch. Once it is available at such a branch, it can be picked up by any tools that can point to Github based Helm Repositories (e.g. Rancher Cluster Explorer Apps & Marketplace).
-- If you encounter bugs, undo the `make charts` commit (e.g. `git reset HEAD~1 --hard` or `git reset HEAD~1 --soft; git checkout -- .; git clean -df` if you want to do it in multiple steps) and repeat the above steps.
+- Run `make clean`. Make a commit with your `packages/` changes
+- Run `make charts`. Make a commit with your `charts/` changes
+- Test your changes by pushing it to a branch. Once it is available at such a branch, it can be picked up by any tools that can point to Github based Helm Repositories (e.g. Rancher Cluster Explorer Apps & Marketplace).
+  - Note: If you encounter bugs on testing and need to modify your commits, it is recommended that you continue to keep your `packages/` changes and `charts/` changes separate. Ideally, you should have 1+ commits that modify the `packages/` directory for reviewers to view and 1 commit that modifies the `charts/` directory as a generated changes commit.
 - Once you are ready to make a PR, ensure the last commit contains only the generated `make charts` changes and submit a PR. The PR workflow will automatically run `make validate` to ensure that your current repository wouldn't introduce any conflicts during a release.
 - Open up a PR with your changes.