1
0
mirror of https://github.com/badges/shields.git synced 2025-04-18 19:44:04 +03:00

47 Commits

Author SHA1 Message Date
chris48s
e499030e28
Improve donate Call To Action (#10777)
* add a 'donate' page to the site

* remove offer to pay expenses

* remove suggested amount from repo CTAs
2025-01-01 16:07:58 +00:00
Pierre-Yves Bigourdan
1e4c8f54d7
Sunsetting Shields custom logos (#10347)
* Sunsetting Shields custom logos

* Reinstate info to contribute to SimpleIcons

* Mention that no changes are required
2024-07-13 19:14:54 +00:00
chris48s
b96192eec6
remove redis token persistence backend (#9065)
* remove redis token persistence backend

* error and exit if redis_url is set
2023-04-15 20:17:35 +01:00
chris48s
ab51c88d94
update docs following token pool changes (#8933)
* update docs following token pool changes

* Update CONTRIBUTING.md

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>

---------

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2023-03-04 19:44:08 +00:00
Seth Falco
2c6390a663
docs: update wording and url for freecodecamp usernames (#8480)
* docs: update wording and url for freecodecamp usernames

* docs: fix typo in CONTRIBUTING.md

Co-authored-by: chris48s <chris48s@users.noreply.github.com>
2022-10-07 19:43:43 +00:00
Pierre-Yves B
d4116b3ab0
Allow links only for social badges, affects [GitHubMilestone Dependabot] (#6159)
* Allow links only for social badges, affects [GitHubMilestone Dependabot]

* Remove getLink function

* Remove unused import

* Mention social links in guidelines as well
2021-02-08 19:58:20 +00:00
Caleb Cartwright
806c52bdd6
Update Contributing documentation on PRs/service tests & amending history (#6128)
* docs: update contributing info on PRs/tests & amending history

* docs: include git config links

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-02-02 00:54:23 +00:00
Pierre-Yves B
3eadcf448f
Add guidelines about including tokens in badge URLs (#5522)
* Add guidelines about including tokens in badge URLs

* Tweak wording

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>
2020-09-13 09:08:32 +02:00
chris48s
164e9ea737
add guidance about scraping and unofficial APIs (#5393) 2020-08-06 19:15:11 +01:00
Pierre-Yves B
964ad08767
Prepare Discussions launch (#5288) 2020-07-06 09:34:49 +02:00
chris48s
e879682e29
Add documentation for designing badge URLs (#4435)
* Add documentation for designing badge URLs
Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>
2019-12-22 17:05:00 +00:00
Caleb Cartwright
e9860aefbc update contributing docs on url/query params (#4141)
* doc: update contribitung docs on url/query params

* chore: minor doc tweaks
2019-10-07 12:28:55 +00:00
chris48s
60bd7a69a7 link to contributing.shields.io in the docs (#3957)
* link to shields-docs.netlify.com in the docs

* update links to contributing.shields.io
2019-09-09 20:37:43 +00:00
Caleb Cartwright
60e69ee43b
docs: fix link in Contributing guide (#3457) 2019-05-14 15:25:55 -05:00
chris48s
a47fb2895d update logo guidance (#2888)
Ref #2510
2019-01-29 15:29:51 -06:00
Paul Melnikow
aac2a4d5ad
Move legacy request helpers (#2829)
In #2698 we decided to put legacy helper functions in `core/legacy`. I think that’s a fine idea, though if we’re going to have a bunch of badge helper functions in there, it seems like it is probably better to keep these two important but esoteric helper functions with the core code to which they are most coupled. So I added `legacy-` to the name, and put them in `core/base-service`.
2019-01-21 22:14:22 -05:00
Paul Melnikow
8c7404a571
Run Prettier on the rest of the things (#2662) 2019-01-07 18:33:17 -05:00
Manaswini Das
d87ac49b43 Improves CONTRIBUTING.md (#2594) 2018-12-26 21:25:23 +00:00
Marcin Mielnicki
de1eb664ec
Precommit hook with Prettier and ESLint (#2178)
* Precommit hook with prettier and eslint added

* Info about running prettier removed from documentation

* Info about a pre-commit hook in documentation
2018-10-19 11:16:30 +02:00
chris48s
10e8232ffa
Add multiple issue templates (#2128) 2018-09-30 17:00:09 +01:00
Pyves
3e69873930
[aur packagist php-eye travis vaadin-directory github david jitpack twitter] Enforced lowercase badge labels (#2058) 2018-09-09 11:41:10 +01:00
chris48s
ef6e601aaa
Update tutorial to reflect new service layout (#2042)
update the tutorial for new service class layout
2018-09-05 21:34:41 +01:00
chris48s
7136aac89a
update contributing guidance (#2019) 2018-08-29 22:36:24 +01:00
chris48s
17481f144a
update logo submission docs (#2020)
add more detail to image submission guidelines
2018-08-29 22:32:46 +01:00
Nicco Kunzmann
147d0e9bcc add examples for documentation contributions (#1962)
The section for documentation contribution is quite short.
This adds examples of when to make a contribution.
2018-08-23 16:32:11 -04:00
Paul Melnikow
a16d436602
Optionally persist [Github] tokens in Redis (#1939)
This is a fairly simple addition of a Redis-backed TokenPersistence. When GithubConstellation is initialized, it will create a FsTokenPersistence or a RedisTokenPersistence based on configuration. Have added tests of the Redis backend as an integration test, and ensured the server starts up correctly when a `REDIS_URL` is configured.

Ref: #1848
2018-08-19 10:27:23 -04:00
Paul Melnikow
ab051b3804
Turn on prettier (except repo root) (#1167)
* Use prettier-check
* Update semi option
    See discussion https://github.com/badges/shields/issues/948#issuecomment-349205606
* Developer documentation
* Run the same steps in both `main` jobs
* Move integration tests from `danger` to `main` where they belong
2018-08-08 17:49:06 -04:00
Thomas Broadley
2ded83f8a6 Documentation typos (#1647) 2018-04-15 20:43:51 +01:00
Paul Melnikow
ea4b758612
Move service tests alongside code (#1563)
Per discussion in #1543
2018-03-20 18:32:48 -07:00
Paul Melnikow
e37668b392
We have no more pull requests to adopt (#1587)
We’ve cleared the backlog of pull requests needing adoption and closed the old ones out, so it seems best to remove this from the contributing guidelines.
2018-03-19 20:27:47 -04:00
Pyves
276f821317
Update contributing guidelines (#1551)
* Added logo acceptance criteria

* Added repository starring section

* Added logo approval expectation sentence

* Extended to spreading the word section

* Rearranged sections
2018-03-09 19:10:03 +00:00
Paul Melnikow
ec3971b984
Update contributing guidelines (#1357) 2017-12-09 12:02:45 -05:00
Paul Melnikow
8fa751d0c5
Activating Open Collective (#1295)
See comments in #1250. Gratipay is shutting down.
2017-11-30 14:19:50 -05:00
Paul Melnikow
f0e6181ec4
CONTRIBUTING: Add code review to ways to help (#1269) 2017-11-25 21:05:54 -05:00
Paul Melnikow
446d4ce21e Correct cache behavior for custom query parameters (#1186)
I developed this for #820 to provide the correct cache behavior when a service wants to use custom parameters from the query string.

For safety, only the declared parameters (and the global parameters) are provided to the service. Consequently, failure to declare a parameter results in the parameter not working at all (undesirable, but easy to debug) rather than indeterminate behavior that depends on the cache state (undesirable, but hard to debug).
2017-10-24 23:00:23 -04:00
Paul Melnikow
5fbdc5e773 Docs: Cosmetic, link fixes, and copyedits (#1176) 2017-10-14 15:01:45 -04:00
Paul Melnikow
16045fdff8 Update documentation (#1129)
I wrote a new readme and contributing guidelines, and took a rough pass through the rest of the documentation.
2017-10-14 11:43:52 -04:00
Paul Melnikow
cca46b7e94 Generate index.html only on gh-pages when deploying
- Build index.html at deploy time
- Update corresponding documentation references
- Since index.html is untracked, git add needs -f
- Clarify gh-pages generated commit message
- Improve Makefile dependencies related to website generation

As discussed in #936, tracking the index.html causes makes PRs longer / noisier
and causes extra merge conflicts. More importantly, it causes contributors to
inadvertently edit the wrong file, which causes extra work (#949) or
contributions to be lost (#898).

Since there's no need for index.html in development (everything uses try.html) a
logical solution is to generate and commit the index.html at deploy time.

Recording compiled or generated files in a deploy commit is a reasonable
practice for git-based deploys (Heroku, gh-pages, and others).

The old version of this was slightly "unsafe" for my taste, in that it depended
on the local copy of gh-pages (if it existed) and master. The new version just
replaces gh-pages with master + the new commit.

Closes #936.

Fixes #954 (the PR).
2017-04-25 23:40:08 +02:00
Nicco Kunzmann
21a3aef427 Add tutorial on how to add a new service (#889) 2017-03-30 11:46:10 -04:00
Thaddee Tyl
225ed98663 Mention the need to minimize .svg images
As suggested by https://github.com/badges/shields/pull/861#discussion_r96729020.
2017-01-24 23:03:12 +01:00
Thaddee Tyl
479b5c6666 Document the command to generate index.html 2016-03-28 19:53:49 +02:00
Thaddee Tyl
a82db53597 Describe the recipe for badge URLs 2016-01-31 18:15:27 +01:00
Thaddee Tyl
784de4a8ec Ground design rules for large modifications 2015-11-24 20:12:54 +01:00
Rebornix
a525dfa28f Add a link to C# port of Shield style badge lib.
When we try to add a badge service to [visual studio gallery](visualstudiogallery.msdn.microsoft.com), we find Shield is the best option but there is no .NET implementation. So we port it to [.NET](https://github.com/rebornix/DotBadge) for better code integration.

I'll appreciate it if you can add a link to C# port of Shield badge library and CLI, which can bring more audience to this tiny draft project. But we can understand if you don't, as it's not an official one :)
2015-05-11 21:13:29 +02:00
Thaddee Tyl
0ef15011bd Clarify the state of badge implementations
See https://github.com/badges/shields/issues/377#issuecomment-76528216
2015-02-28 16:00:36 +01:00
Thaddee Tyl
90eeafe8a0 Mention that contributors should modify try.html.
Fixes #131.
2014-02-26 10:58:06 +01:00
Thaddee Tyl
3f3f1b30bb Files related to the switch to the shields repo. 2014-02-23 22:53:34 +01:00