Skip to content

Commit 0cc7b11

Browse files
committed
docs(scripts): add small guide for contribution for theme info
1 parent 28160ea commit 0cc7b11

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,27 @@ A collection site of Firefox userchrome themes, mostly from FirefoxCSS Reddit.<b
6868

6969
---
7070

71+
### Contribution: themes information
72+
73+
1. Install [nushell](https://www.nushell.sh/) in your machine.
74+
2. Generate a [Github token API](https://github.com/settings/tokens) for your account and save it;
75+
2. Clone the repository;
76+
3. In your terminal, change directory into the `/scripts/` folder.
77+
4. Run `nu`.
78+
5. Run `use sort_themes.nu`;
79+
6. Run `sort_themes --help` and read and understand the flags;
80+
7. Run `sort_themes --github YOUR_GITHUB_TOKEN`;
81+
8. Check if everything ran fine, if yes, replace the new generated `themes.json` file.
82+
9. Commit your changes.
83+
10. Open a pull request and send your contribution for us to review.
84+
11. Thank you :)
85+
86+
**Why generate a token API for only Github?**
87+
88+
Most themes' repositories are in Gitub, so it's pretty easy to hit the anonymous rate limit for API calls. With a token, that limit is higher, making it easier to contribute.
89+
90+
---
91+
7192
<h1 align="center">What do you think =?</h1>
7293

7394
<p align="center">Feel free to send me any feedback via issue or my twitter <a href="https://twitter.com/Neikon66">@Neikon66</a>.</p>

0 commit comments

Comments
 (0)