56 lines
2.5 KiB
Markdown
56 lines
2.5 KiB
Markdown
# Contribution Guidelines
|
|
|
|
This is the home of Shields.io, containing the badge design specification and API documentation for Badges as a Service. There is also a [gh-pages branch][website] containing the static web site at [shields.io][].
|
|
|
|
We invite participation through [GitHub Issues][], which we use much like a discussion forum. This repository should only contain non-implementation specific topics: specifications, design, and the web site.
|
|
|
|
## This implementation
|
|
|
|
Please see [INSTALL.md][] for information on how to get started.
|
|
|
|
[INSTALL.md]: ./INSTALL.md
|
|
|
|
Note that the root gets redirected to <http://shields.io>.
|
|
For testing purposes, you can go to `http://localhost/try.html`.
|
|
You should modify that file. The "real" root, `http://localhost/index.html`,
|
|
gets generated from the `try.html` file.
|
|
|
|
## Implementations
|
|
|
|
Please report **bugs** and discuss implementation specific concerns (performance characteristics, etc.) in the repository for the respective implementation:
|
|
|
|
| website / AP | language | issues |
|
|
| ----------------------------- | ---------- | ----------------------------- |
|
|
| [img.shields.io][] * | JavaScript | [shields][gh-badges issues] |
|
|
| shielded | JavaScript | [shielded][shielded issues] |
|
|
| [buckler.repl.ca][] | Go | [buckler][buckler issues] |
|
|
| old img.shields.io * | Python | [img.shields.io-old][] |
|
|
|
|
\* gh-badges (ex-`b.adge.me`) [has been adopted][primary] as the primary implementation going forward
|
|
\* img.shields.io is being disbanded and replaced with gh-badges
|
|
|
|
## Adding support for a service
|
|
|
|
Please [open an issue][new issue] if you'd like to use Shields badges for a project that isn't yet supported.
|
|
|
|
## Shields-as-a-Service
|
|
|
|
Our long term goal is to transform Shields into a service with which widely compatible badges can be generated via a simple API call, any help with this would be much appreciated.
|
|
|
|
[shields.io]: http://shields.io/
|
|
[website]: https://github.com/badges/shields/tree/gh-pages
|
|
[GitHub Issues]: https://github.com/badges/shields/issues
|
|
[new issue]: https://github.com/badges/shields/issues/new
|
|
|
|
[img.shields.io]: http://img.shields.io/
|
|
[gh-badges issues]: https://github.com/badges/shields/issues
|
|
[primary]: https://github.com/badges/shields/issues/94
|
|
|
|
[shielded issues]: https://github.com/badges/shielded/issues
|
|
|
|
[buckler.repl.ca]: http://buckler.repl.ca/
|
|
[buckler issues]: https://github.com/badges/buckler/issues
|
|
|
|
[img.shields.io-old]: https://github.com/badges/img.shields.io-old/issues
|
|
|