mirror of
https://github.com/ForkAwesome/Fork-Awesome.git
synced 2024-12-26 05:21:31 +08:00
Updating meta-data of packages
This commit is contained in:
Julien Deswaef
parent
cb0a13588c
commit
66851af85a
@ -1,14 +1,13 @@
|
||||
# Contributing to Fork Awesome
|
||||
|
||||
Looking to contribute something to Font Awesome? **Here's how you can help.**
|
||||
Looking to contribute something to Fork Awesome? **Here's how you can help.**
|
||||
|
||||
## Requesting new icons
|
||||
|
||||
New icons mostly start as requests by the [Font Awesome community on GitHub](../../issues). Want to request a new icon? Here are some things to keep in mind:
|
||||
New icons mostly start as requests by the [Fork Awesome community on GitHub](../../issues). Want to request a new icon? Here are some things to keep in mind:
|
||||
|
||||
1. Please be nice. Font Awesome is a happy place.
|
||||
2. Please do not request comprehensive sets of icons related to a very specific field.
|
||||
3. Please [search](../../search?type=Issues) to see if your icon request already exists. If a request is found, please add a 👍 reaction to that one.
|
||||
1. Please be nice. Fork Awesome is a happy place.
|
||||
2. Please [search](../../search?type=Issues) to see if your icon request already exists. If a request is found, please add a 👍 reaction to that one.
|
||||
4. Please make requests for single icons, unless you are requesting a couple of strictly related icons (e.g., thumbs-up/thumbs-down).
|
||||
5. Please and thank you if you include the following:
|
||||
- Title your [new issue](../../issues/new?title=Icon%20Request:%20icon-) `Icon request: icon-name` (e.g., `Icon request: icon-car`).
|
||||
@ -17,10 +16,9 @@ New icons mostly start as requests by the [Font Awesome community on GitHub](../
|
||||
- Request concrete objects: it's harder to make an icon to represent happiness, it's easier to make a smiley face. ☺
|
||||
|
||||
|
||||
|
||||
## Suggesting icon keyword addition/removal
|
||||
|
||||
Icon filters are maintained by the [Font Awesome community on GitHub](../../pulls?q=is%3Apr+label%3Adoc).
|
||||
Icon filters are maintained by the [Fork Awesome community on GitHub](../../pulls?q=is%3Apr+label%3Adoc).
|
||||
|
||||
If you feel that an icon
|
||||
|
||||
@ -30,35 +28,29 @@ If you feel that an icon
|
||||
please send a [PR](https://help.github.com/articles/using-pull-requests/) to the `master` branch.
|
||||
|
||||
|
||||
|
||||
## Reporting issues
|
||||
|
||||
We only accept issues that are icon requests, bug reports, or feature requests. Bugs must be isolated and reproducible problems that we can fix within the Font Awesome core. Please read the following guidelines to ensure you are the paragon of bug reporting.
|
||||
We only accept issues that are icon requests, bug reports, or feature requests. Bugs must be isolated and reproducible problems that we can fix within the Fork Awesome core. Please read the following guidelines to ensure you are the paragon of bug reporting.
|
||||
|
||||
1. **Search for existing issues.** We get a lot of duplicate issues, and you'd help us out a lot by first checking if someone else has reported the same issue. Moreover, the issue may have already been resolved with a fix available.
|
||||
2. **Create an isolated and reproducible test case.** Be sure the problem exists in Font Awesome's code with a [reduced test case](http://css-tricks.com/reduced-test-cases/) that should be included in each bug report.
|
||||
2. **Create an isolated and reproducible test case.** Be sure the problem exists in Fork Awesome's code with a [reduced test case](http://css-tricks.com/reduced-test-cases/) that should be included in each bug report.
|
||||
3. **Include a live example.** Make use of jsFiddle, jsBin, or Codepen to share your isolated test cases.
|
||||
4. **Share as much information as possible.** Include operating system and version, browser and version, version of Font Awesome, etc. where appropriate. Also include steps to reproduce the bug.
|
||||
|
||||
4. **Share as much information as possible.** Include operating system and version, browser and version, version of Fork Awesome, etc. where appropriate. Also include steps to reproduce the bug.
|
||||
|
||||
|
||||
## Key branches
|
||||
|
||||
- `master` is the latest, deployed version (use for pull request if they only affect the docs)
|
||||
- `master` is the latest, deployed version
|
||||
- `gh-pages` is the hosted docs (not to be used for pull requests)
|
||||
- `*-wip` branches are the official work in progress branches for the next releases. All pull requests should be submitted against the appropriate branch
|
||||
|
||||
|
||||
|
||||
## Notes on the repo
|
||||
|
||||
As of v3.2.0, Font Awesome's CSS, LESS, SCSS, and documentation are all powered by Jekyll templates and built before each commit and release.
|
||||
Fork Awesome's CSS, LESS, SCSS, and documentation are all powered by Jekyll templates and built before each commit and release.
|
||||
- `_config.yml` - much of the site is driven off variables from this file, including Font Awesome and Bootstrap versions
|
||||
- `src/` - All edits to documentation, LESS, SCSS, and CSS should be made to files and templates in this directory
|
||||
- `src/icons.yml` - all LESS, SCSS, and CSS icon definitions are driven off this single file
|
||||
|
||||
|
||||
|
||||
## Pull requests
|
||||
|
||||
- Any changes to the docs must be made to the Liquid templates in the `src` directory
|
||||
@ -68,7 +60,6 @@ As of v3.2.0, Font Awesome's CSS, LESS, SCSS, and documentation are all powered
|
||||
- Try to share which browsers your code has been tested in before submitting a pull request
|
||||
|
||||
|
||||
|
||||
## Coding standards: HTML
|
||||
|
||||
- Two spaces for indentation, never tabs
|
||||
@ -77,7 +68,6 @@ As of v3.2.0, Font Awesome's CSS, LESS, SCSS, and documentation are all powered
|
||||
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags)
|
||||
|
||||
|
||||
|
||||
## Coding standards: CSS
|
||||
|
||||
- Adhere to the [Recess CSS property order](http://markdotto.com/2011/11/29/css-property-order/)
|
||||
@ -88,14 +78,12 @@ As of v3.2.0, Font Awesome's CSS, LESS, SCSS, and documentation are all powered
|
||||
- Attribute selectors, like `input[type="text"]` should always wrap the attribute's value in double quotes, for consistency and safety (see this [blog post on unquoted attribute values](http://mathiasbynens.be/notes/unquoted-attribute-values) that can lead to XSS attacks)
|
||||
|
||||
|
||||
|
||||
## License
|
||||
|
||||
By contributing your code, you agree to license your contribution under the terms of the MIT License:
|
||||
- http://opensource.org/licenses/mit-license.html
|
||||
|
||||
|
||||
|
||||
## Thanks
|
||||
|
||||
Thanks to Bootstrap for their wonderful CONTRIBUTING.MD doc. It was modified to create this one.
|
||||
|
||||
10
bower.json
10
bower.json
@ -1,14 +1,14 @@
|
||||
{
|
||||
"name": "font-awesome",
|
||||
"description": "Font Awesome",
|
||||
"name": "fork-awesome",
|
||||
"description": "Fork Awesome",
|
||||
"keywords": [],
|
||||
"homepage": "http://fontawesome.io",
|
||||
"homepage": "http://forkawesome.github.io/Fork-Awesome",
|
||||
"dependencies": {},
|
||||
"devDependencies": {},
|
||||
"license": ["OFL-1.1", "MIT", "CC-BY-3.0"],
|
||||
"main": [
|
||||
"less/font-awesome.less",
|
||||
"scss/font-awesome.scss"
|
||||
"less/fork-awesome.less",
|
||||
"scss/fork-awesome.scss"
|
||||
],
|
||||
"ignore": [
|
||||
"*/.*",
|
||||
|
||||
@ -8,14 +8,14 @@
|
||||
"development": {},
|
||||
"license": "SIL, MIT, CC BY 3.0",
|
||||
"styles": [
|
||||
"css/font-awesome.css"
|
||||
"css/fork-awesome.css"
|
||||
],
|
||||
"fonts": [
|
||||
"fonts/fontawesome-webfont.eot",
|
||||
"fonts/fontawesome-webfont.svg",
|
||||
"fonts/fontawesome-webfont.ttf",
|
||||
"fonts/fontawesome-webfont.woff",
|
||||
"fonts/fontawesome-webfont.woff2",
|
||||
"fonts/FontAwesome.otf"
|
||||
"fonts/forkawesome-webfont.eot",
|
||||
"fonts/forkawesome-webfont.svg",
|
||||
"fonts/forkawesome-webfont.ttf",
|
||||
"fonts/forkawesome-webfont.woff",
|
||||
"fonts/forkawesome-webfont.woff2",
|
||||
"fonts/ForkAwesome.otf"
|
||||
]
|
||||
}
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"name": "forkawesome/fork-awesome",
|
||||
"description": "A fork of the iconic font and CSS framework",
|
||||
"keywords": ["font", "awesome", "fontawesome", "icon", "font", "bootstrap"],
|
||||
"homepage": "http://forkawesome.github.io/",
|
||||
"homepage": "http://forkawesome.github.io/Fork-Awesome/",
|
||||
"type": "component",
|
||||
"authors": [
|
||||
{
|
||||
|
||||
2
package-lock.json
generated
2
package-lock.json
generated
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "fork-awesome",
|
||||
"version": "4.7.0",
|
||||
"version": "0.4.7",
|
||||
"lockfileVersion": 1,
|
||||
"requires": true,
|
||||
"dependencies": {
|
||||
|
||||
23
package.json
23
package.json
@ -1,29 +1,30 @@
|
||||
{
|
||||
"name": "fork-awesome",
|
||||
"description": "A fork of the iconic font and CSS framework",
|
||||
"version": "4.7.0",
|
||||
"style": "css/font-awesome.css",
|
||||
"version": "0.4.7",
|
||||
"style": "css/fork-awesome.css",
|
||||
"keywords": [
|
||||
"font",
|
||||
"awesome",
|
||||
"forkawesome",
|
||||
"fontawesome",
|
||||
"icon",
|
||||
"bootstrap"
|
||||
],
|
||||
"homepage": "",
|
||||
"homepage": "https://forkawesome.github.io/Fork-Awesome",
|
||||
"bugs": {
|
||||
"url": "http://github.com/ForkAwesome/Fork-Awesome/issues"
|
||||
},
|
||||
"author": {
|
||||
"name": "Dave Gandy",
|
||||
"email": "dave@fontawesome.io",
|
||||
"web": "http://twitter.com/davegandy"
|
||||
},
|
||||
"author": "Fork Awesome Community",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/ForkAwesome/Fork-Awesome.git"
|
||||
},
|
||||
"contributors": [
|
||||
{
|
||||
"name": "Dave Gandy",
|
||||
"web": "http://twitter.com/davegandy"
|
||||
},
|
||||
{
|
||||
"name": "Brian Talbot",
|
||||
"web": "http://twitter.com/talbs"
|
||||
@ -43,14 +44,14 @@
|
||||
],
|
||||
"license": "(OFL-1.1 AND MIT)",
|
||||
"dependencies": {},
|
||||
"devDependencies": {
|
||||
"less-plugin-clean-css": "^1.5.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=0.10.3"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "bundle exec jekyll build",
|
||||
"dev": "bundle exec jekyll -w serve"
|
||||
},
|
||||
"devDependencies": {
|
||||
"less-plugin-clean-css": "^1.5.1"
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user