Skip to content
This repository has been archived by the owner on Feb 3, 2021. It is now read-only.

Commit

Permalink
Add All Contributors to the spacefish README.md (#114)
Browse files Browse the repository at this point in the history
  • Loading branch information
Matan Kushner committed Nov 26, 2018
1 parent f43422b commit 42f27c5
Show file tree
Hide file tree
Showing 5 changed files with 2,091 additions and 903 deletions.
137 changes: 137 additions & 0 deletions .all-contributorsrc
@@ -0,0 +1,137 @@
{
"projectName": "spacefish",
"projectOwner": "matchai",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 100,
"commit": true,
"contributors": [
{
"login": "matchai",
"name": "Matan Kushner",
"avatar_url": "https://avatars0.githubusercontent.com/u/4658208?v=4",
"profile": "https://twitter.com/matchai",
"contributions": [
"bug",
"code",
"doc",
"review",
"test",
"tool",
"design"
]
},
{
"login": "sirMerr",
"name": "Tiffany Le-Nguyen",
"avatar_url": "https://avatars2.githubusercontent.com/u/11183523?v=4",
"profile": "https://github.com/sirMerr",
"contributions": [
"bug",
"code",
"doc",
"review"
]
},
{
"login": "Snuggle",
"name": "Snuggle",
"avatar_url": "https://avatars0.githubusercontent.com/u/26250962?v=4",
"profile": "https://github.com/Snuggle",
"contributions": [
"bug",
"code",
"doc",
"review",
"test"
]
},
{
"login": "jskrnbindra",
"name": "Jaskaran Bindra",
"avatar_url": "https://avatars2.githubusercontent.com/u/11844760?v=4",
"profile": "https://github.com/jskrnbindra",
"contributions": [
"code",
"doc",
"test"
]
},
{
"login": "kulabun",
"name": "Konstantin Labun",
"avatar_url": "https://avatars3.githubusercontent.com/u/6306918?v=4",
"profile": "https://labun.me",
"contributions": [
"code",
"doc",
"test"
]
},
{
"login": "kyleholzinger",
"name": "Kyle Holzinger",
"avatar_url": "https://avatars0.githubusercontent.com/u/2652762?v=4",
"profile": "https://medium.com/@kyleholzinger",
"contributions": [
"code",
"doc"
]
},
{
"login": "salmanulfarzy",
"name": "Salmanul Farzy",
"avatar_url": "https://avatars0.githubusercontent.com/u/10276208?v=4",
"profile": "https://github.com/salmanulfarzy",
"contributions": [
"code",
"review"
]
},
{
"login": "owais",
"name": "owais",
"avatar_url": "https://avatars0.githubusercontent.com/u/46186?v=4",
"profile": "https://owais.lone.pw",
"contributions": [
"code",
"doc",
"test"
]
},
{
"login": "ladysamantha",
"name": "Samantha Enders",
"avatar_url": "https://avatars3.githubusercontent.com/u/35412203?v=4",
"profile": "https://github.com/ladysamantha",
"contributions": [
"code",
"doc",
"test"
]
},
{
"login": "evanrelf",
"name": "Evan Relf",
"avatar_url": "https://avatars2.githubusercontent.com/u/887196?v=4",
"profile": "https://evanrelf.com",
"contributions": [
"code",
"doc"
]
},
{
"login": "JasonEtco",
"name": "Jason Etcovitch",
"avatar_url": "https://avatars1.githubusercontent.com/u/10660468?v=4",
"profile": "https://jasonet.co",
"contributions": [
"code",
"doc"
]
}
]
}
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -40,11 +40,24 @@ Every additional section will slow down the prompt a little bit. If your section
* **Good:** check if a command exists, check the value of an environment variable
* **Bad:** network requests, reading large files, etc

### Documentation
## Documentation

When updating documentation for your section, make sure the markdown document is being properly rendered by Github. Specifically, the following common pitfalls have already been discovered:

* Empty inline code blocks ` ` will only be rendered if you put at least one non-breaking whitespace " " inside, like so: `` ` ` `` β†’ ` `
* Leading and trailing whitespaces in inline code blocks will be stripped, to indicate that a whitespace is present, use the middot symbol `Β·`, like so: `` `🐟·` `` β†’ `🐟·`

## Add yourself as a contributor

This project follows the [all contributors](https://github.com/kentcdodds/all-contributors) specification. To add yourself to the table of
contributors on the README.md, please use the automated script as part of your PR:

```console
npm install
npm run contributors:add -- <YOUR_GITHUB_USERNAME>
```

Follow the prompt. If you've already added yourself to the list and are making a new type of contribution, you can run
it again and select the added contribution type.

**Thank you for reading the contribution guide! Happy hacking!**
18 changes: 17 additions & 1 deletion README.md
Expand Up @@ -38,7 +38,7 @@
<div align="center">
<sub>Built with ❀︎ by
<a href="https://matchai.me">Matan Kushner</a> and
<a href="https://github.com/matchai/spacefish/graphs/contributors">contributors </a></sub>
<a href="#contributors">contributors </a></sub>
<br>
<sub>A port of <a href="https://github.com/denysdovhan/spaceship-prompt">Spaceship ZSH</a> by
<a href="https://denysdovhan.com/">Denys Dovhan</a></sub>
Expand Down Expand Up @@ -95,12 +95,14 @@ Spacefish is a minimalistic, powerful and extremely customizable <a href="https:
Want more features? Please [open an issue](https://github.com/matchai/spacefish/issues/new?template=Feature_request.md) or send pull request!

## Requirements

To get spacefish working correctly, you will need:

* [`fish`][fish] (v2.7.0 or newer)
* [Powerline Font](https://github.com/powerline/fonts) must be installed and enabled in your terminal.

## Installation

### [Fisher](https://github.com/jorgebucaran/fisher)

```fish
Expand All @@ -114,6 +116,7 @@ $ omf install spacefish
```

## Customization

Spacefish works really well out of the box, but you can customize your fish to your heart's content!

* [**Options**](./docs/Options.md) β€” Tweak section's behavior with tons of options.
Expand All @@ -126,6 +129,19 @@ Having issues? Take a look at our [Troubleshooting](./docs/Troubleshooting.md) p

Still struggling? Please [file an issue](https://github.com/matchai/spacefish/issues/new?template=Support_question.md), describe your problem, and we will gladly help you.

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars0.githubusercontent.com/u/4658208?v=4" width="100px;"/><br /><sub><b>Matan Kushner</b></sub>](https://twitter.com/matchai)<br />[πŸ›](https://github.com/matchai/spacefish/issues?q=author%3Amatchai "Bug reports") [πŸ’»](https://github.com/matchai/spacefish/commits?author=matchai "Code") [πŸ“–](https://github.com/matchai/spacefish/commits?author=matchai "Documentation") [πŸ‘€](#review-matchai "Reviewed Pull Requests") [⚠️](https://github.com/matchai/spacefish/commits?author=matchai "Tests") [πŸ”§](#tool-matchai "Tools") [🎨](#design-matchai "Design") | [<img src="https://avatars2.githubusercontent.com/u/11183523?v=4" width="100px;"/><br /><sub><b>Tiffany Le-Nguyen</b></sub>](https://github.com/sirMerr)<br />[πŸ›](https://github.com/matchai/spacefish/issues?q=author%3AsirMerr "Bug reports") [πŸ’»](https://github.com/matchai/spacefish/commits?author=sirMerr "Code") [πŸ“–](https://github.com/matchai/spacefish/commits?author=sirMerr "Documentation") [πŸ‘€](#review-sirMerr "Reviewed Pull Requests") | [<img src="https://avatars0.githubusercontent.com/u/26250962?v=4" width="100px;"/><br /><sub><b>Snuggle</b></sub>](https://github.com/Snuggle)<br />[πŸ›](https://github.com/matchai/spacefish/issues?q=author%3ASnuggle "Bug reports") [πŸ’»](https://github.com/matchai/spacefish/commits?author=Snuggle "Code") [πŸ“–](https://github.com/matchai/spacefish/commits?author=Snuggle "Documentation") [πŸ‘€](#review-Snuggle "Reviewed Pull Requests") [⚠️](https://github.com/matchai/spacefish/commits?author=Snuggle "Tests") | [<img src="https://avatars2.githubusercontent.com/u/11844760?v=4" width="100px;"/><br /><sub><b>Jaskaran Bindra</b></sub>](https://github.com/jskrnbindra)<br />[πŸ’»](https://github.com/matchai/spacefish/commits?author=jskrnbindra "Code") [πŸ“–](https://github.com/matchai/spacefish/commits?author=jskrnbindra "Documentation") [⚠️](https://github.com/matchai/spacefish/commits?author=jskrnbindra "Tests") | [<img src="https://avatars3.githubusercontent.com/u/6306918?v=4" width="100px;"/><br /><sub><b>Konstantin Labun</b></sub>](https://labun.me)<br />[πŸ’»](https://github.com/matchai/spacefish/commits?author=kulabun "Code") [πŸ“–](https://github.com/matchai/spacefish/commits?author=kulabun "Documentation") [⚠️](https://github.com/matchai/spacefish/commits?author=kulabun "Tests") | [<img src="https://avatars0.githubusercontent.com/u/2652762?v=4" width="100px;"/><br /><sub><b>Kyle Holzinger</b></sub>](https://medium.com/@kyleholzinger)<br />[πŸ’»](https://github.com/matchai/spacefish/commits?author=kyleholzinger "Code") [πŸ“–](https://github.com/matchai/spacefish/commits?author=kyleholzinger "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/10276208?v=4" width="100px;"/><br /><sub><b>Salmanul Farzy</b></sub>](https://github.com/salmanulfarzy)<br />[πŸ’»](https://github.com/matchai/spacefish/commits?author=salmanulfarzy "Code") [πŸ‘€](#review-salmanulfarzy "Reviewed Pull Requests") |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| [<img src="https://avatars0.githubusercontent.com/u/46186?v=4" width="100px;"/><br /><sub><b>owais</b></sub>](https://owais.lone.pw)<br />[πŸ’»](https://github.com/matchai/spacefish/commits?author=owais "Code") [πŸ“–](https://github.com/matchai/spacefish/commits?author=owais "Documentation") [⚠️](https://github.com/matchai/spacefish/commits?author=owais "Tests") | [<img src="https://avatars3.githubusercontent.com/u/35412203?v=4" width="100px;"/><br /><sub><b>Samantha Enders</b></sub>](https://github.com/ladysamantha)<br />[πŸ’»](https://github.com/matchai/spacefish/commits?author=ladysamantha "Code") [πŸ“–](https://github.com/matchai/spacefish/commits?author=ladysamantha "Documentation") [⚠️](https://github.com/matchai/spacefish/commits?author=ladysamantha "Tests") | [<img src="https://avatars2.githubusercontent.com/u/887196?v=4" width="100px;"/><br /><sub><b>Evan Relf</b></sub>](https://evanrelf.com)<br />[πŸ’»](https://github.com/matchai/spacefish/commits?author=evanrelf "Code") [πŸ“–](https://github.com/matchai/spacefish/commits?author=evanrelf "Documentation") | [<img src="https://avatars1.githubusercontent.com/u/10660468?v=4" width="100px;"/><br /><sub><b>Jason Etcovitch</b></sub>](https://jasonet.co)<br />[πŸ’»](https://github.com/matchai/spacefish/commits?author=JasonEtco "Code") [πŸ“–](https://github.com/matchai/spacefish/commits?author=JasonEtco "Documentation") |
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

## License

MIT Β© [Matan Kushner](http://matchai.me)
Expand Down

0 comments on commit 42f27c5

Please sign in to comment.