opensourcemirror
/
pop-icon-theme
mirror of https://github.com/pop-os/icon-theme.git
1
0
Fork 0
Code Issues Releases Wiki Activity

docs(readme): clarify point about unrendered icons and re-rendering for PRs

This commit is contained in:
Ian Santopietro 2022-08-08 16:42:28 -06:00
parent 19b3ce9f0a
commit 2cfff7f0f0
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING
View File

@ -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!

4
README.md
View File

@ -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