From 2cfff7f0f0b38b73d090fabf1078d3fff80b005b Mon Sep 17 00:00:00 2001 From: Ian Santopietro Date: Mon, 8 Aug 2022 16:42:28 -0600 Subject: [PATCH] docs(readme): clarify point about unrendered icons and re-rendering for PRs --- CONTRIBUTING | 4 +++- README.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index 83aa7e24b4..ad2ed971c8 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -10,6 +10,8 @@ To improve the quality of your submission and increase the chances of acceptance * Ensure that your changes to icons/cursors follow our in-place development practices. Submissions which add/remove/rename icons within the [`Pop`](./Pop) folder without corresponding changes in the [`src`](./src) folder _will_ not be accepted. -* Consider doing a full-render of the theme before you submit a PR (`./master-render.py -c`). This will erase any existing output files and ensure the theme is in a good, maintainable state and that your changes have been applied in a way which ensures that they will be carried over in the future. _Contributions where running `./master-render.py -c` creates a diff verses the git `HEAD` commit will not be accepted!_ +* Ensure that your icons are rendered out before submitting. Un-render changes will not be visible in the installed theme. + +* Consider doing a full-render of the theme before you submit a PR (`./master-render.py -c`). This will erase any existing output files and ensure the theme is in a good, maintainable state and that your changes have been applied in a way which ensures that they will be carried over in the future. _Contributions where running `./master-render.py -c` creates a diff verses the git `HEAD` commit will not be accepted!_ Performing this step prior to submitting your PR will catch many of the above problems before they appear. These guidelines are important to ensuring the Pop Icons remain maintainable in the future! \ No newline at end of file diff --git a/README.md b/README.md index daaca7fda6..b5c6fa5fe2 100644 --- a/README.md +++ b/README.md @@ -153,7 +153,9 @@ To improve the quality of your submission and increase the chances of acceptance * Ensure that your changes to icons/cursors follow our in-place development practices. Submissions which add/remove/rename icons within the [`Pop`](./Pop) folder without corresponding changes in the [`src`](./src) folder _will_ not be accepted. -* Consider doing a full-render of the theme before you submit a PR (`./master-render.py -c`). This will erase any existing output files and ensure the theme is in a good, maintainable state and that your changes have been applied in a way which ensures that they will be carried over in the future. _Contributions where running `./master-render.py -c` creates a diff verses the git `HEAD` commit will not be accepted!_ +* Ensure that your icons are rendered out before submitting. Un-render changes will not be visible in the installed theme. + +* Consider doing a full-render of the theme before you submit a PR (`./master-render.py -c`). This will erase any existing output files and ensure the theme is in a good, maintainable state and that your changes have been applied in a way which ensures that they will be carried over in the future. _Contributions where running `./master-render.py -c` creates a diff verses the git `HEAD` commit will not be accepted!_ Performing this step prior to submitting your PR will catch many of the above problems before they appear. ## Missing Icons & Requests