Commit Graph
34 Commits
Author SHA1 Message Date
Caleb CartwrightandGitHub 60e69ee43b docs: fix link in Contributing guide (#3457) 2019-05-14 15:25:55 -05:00
chris48sandPaul Melnikow a47fb2895d update logo guidance (#2888)
Ref #2510
2019-01-29 15:29:51 -06:00
Paul MelnikowandGitHub 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 MelnikowandGitHub 8c7404a571 Run Prettier on the rest of the things (#2662) 2019-01-07 18:33:17 -05:00
Manaswini Dasandchris48s d87ac49b43 Improves CONTRIBUTING.md (#2594) 2018-12-26 21:25:23 +00:00
Marcin MielnickiandGitHub 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
chris48sandGitHub 10e8232ffa Add multiple issue templates (#2128) 2018-09-30 17:00:09 +01:00
PyvesandGitHub 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
chris48sandGitHub 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
chris48sandGitHub 7136aac89a update contributing guidance (#2019) 2018-08-29 22:36:24 +01:00
chris48sandGitHub 17481f144a update logo submission docs (#2020)
add more detail to image submission guidelines
2018-08-29 22:32:46 +01:00
Nicco KunzmannandPaul Melnikow 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 MelnikowandGitHub 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 MelnikowandGitHub 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 BroadleyandPyves 2ded83f8a6 Documentation typos (#1647) 2018-04-15 20:43:51 +01:00
Paul MelnikowandGitHub ea4b758612 Move service tests alongside code (#1563)
Per discussion in #1543
2018-03-20 18:32:48 -07:00
Paul MelnikowandGitHub 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
PyvesandGitHub 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 MelnikowandGitHub ec3971b984 Update contributing guidelines (#1357) 2017-12-09 12:02:45 -05:00
Paul MelnikowandGitHub 8fa751d0c5 Activating Open Collective (#1295)
See comments in #1250. Gratipay is shutting down.
2017-11-30 14:19:50 -05:00
Paul MelnikowandGitHub f0e6181ec4 CONTRIBUTING: Add code review to ways to help (#1269) 2017-11-25 21:05:54 -05:00
Paul MelnikowandGitHub 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 MelnikowandGitHub 5fbdc5e773 Docs: Cosmetic, link fixes, and copyedits (#1176) 2017-10-14 15:01:45 -04:00
Paul MelnikowandGitHub 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 MelnikowandThaddee Tyl 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 KunzmannandPaul Melnikow 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
RebornixandThaddee Tyl 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