Skip to content

Commit

Permalink
✨ contributors (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
bradgarropy authored Dec 18, 2024
1 parent 2e31aa5 commit bc0cb59
Show file tree
Hide file tree
Showing 7 changed files with 1,069 additions and 181 deletions.
29 changes: 29 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"projectName": "eslint-config",
"projectOwner": "bradgarropy",
"repoType": "github",
"repoHost": "https://github.com",
"files": ["readme.md", "contributing.md"],
"imageSize": 100,
"contributorsPerLine": 7,
"contributorsSortAlphabetically": false,
"skipCi": false,
"contributors": [
{
"login": "bradgarropy",
"name": "Brad Garropy",
"avatar_url": "https://avatars.githubusercontent.com/u/11336745?v=4",
"profile": "https://bradgarropy.com",
"contributions": ["code", "doc", "infra", "test"]
},
{
"login": "JoshuaKGoldberg",
"name": "Josh Goldberg ✨",
"avatar_url": "https://avatars.githubusercontent.com/u/3335181?v=4",
"profile": "http://www.joshuakgoldberg.com",
"contributions": ["review", "tool"]
}
],
"commitType": "docs",
"commitConvention": "angular"
}
16 changes: 8 additions & 8 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"arrowParens": "avoid",
"bracketSameLine": false,
"bracketSpacing": false,
"endOfLine": "lf",
"jsxSingleQuote": false,
"printWidth": 80,
"tabWidth": 4,
"useTabs": false,
"quoteProps": "consistent",
"semi": false,
"singleQuote": false,
"quoteProps": "consistent",
"jsxSingleQuote": false,
"tabWidth": 4,
"trailingComma": "all",
"bracketSpacing": false,
"jsxBracketSameLine": false,
"arrowParens": "avoid",
"endOfLine": "lf"
"useTabs": false
}
111 changes: 111 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# πŸ‘¨πŸΌβ€πŸ’» contributing

I would love your help to improve this project! Here are a few ways to contribute, and some guidelines to help you along the way.

## πŸ› issues

If you come across any bugs or something that doesn't seem right, please [open an issue][issues]. Also, if you have an idea for the project, open an issue to start the discussion.

When possible, please include a link to a `git` repository or a [CodeSandbox][codesandbox] which illustrates the problem you're facing. This is especially important when you find a bug.

## πŸ”ƒ pull requests

Yes, I accept pull requests! You can submit a pull request to fix a bug, implement a feature, add tests, or improve the documentation.

If you've never created a pull request before, you can [learn how][kcd-pr] for free!

### πŸŽ› setup

In order to submit a pull request, you'll have to setup your own development environment. Start by [forking][fork] the repository.

Then you can clone the forked repository to your system.

```zsh
git clone https://github.com/<username>/eslint-config
```

Next you need to install the dependencies.

```zsh
cd eslint-config
npm install
```

Finally, you can run the project.

```zsh
npm run lint
```

Now you're ready to start writing code!

### πŸ’Ž format

When writing your code, please try to follow the existing code style.

Your code will be automatically linted and formatted before each commit. However, if you want to manually lint and format, use the provided `npm` scripts.

```zsh
npm run lint:fix
npm run format:fix
```

### πŸ§ͺ tests

The project maintains `100%` test coverage. If you change code, please maintain complete test coverage. You can run the tests to confirm.

```zsh
npm run test
```

### πŸ“– documentation

If you make any changes that require documentation updates, please include them in the same pull request.

### πŸ”Ή commits

This project do not enforce a specific commit style. However, if you submit a pull request that closes an issue, please reference it in the commit message.

```zsh
git commit -m "Fix a bug. Closes #1."
```

### πŸ’¬ feedback

Once your pull request is submitted, I may provide you with some feedback. While working on the feedback, please move the pull request to `Draft` state. Once you've finished addressing the feedback, mark the pull request as `Ready for review` and mention me in a comment.

```text
Alright @bradgarropy, how's this?
```

### βš– license

Any code you contribute is subject to the [MIT license][license].

## ✨ contributors

I appreciate any and all types of contributions to this project! Contributors are recognized here and in the [`readme`][contributors].

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://bradgarropy.com"><img src="https://avatars.githubusercontent.com/u/11336745?v=4?s=100" width="100px;" alt="Brad Garropy"/><br /><sub><b>Brad Garropy</b></sub></a><br /><a href="https://github.com/bradgarropy/eslint-config/commits?author=bradgarropy" title="Code">πŸ’»</a> <a href="https://github.com/bradgarropy/eslint-config/commits?author=bradgarropy" title="Documentation">πŸ“–</a> <a href="#infra-bradgarropy" title="Infrastructure (Hosting, Build-Tools, etc)">πŸš‡</a> <a href="https://github.com/bradgarropy/eslint-config/commits?author=bradgarropy" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg ✨"/><br /><sub><b>Josh Goldberg ✨</b></sub></a><br /><a href="https://github.com/bradgarropy/eslint-config/pulls?q=is%3Apr+reviewed-by%3AJoshuaKGoldberg" title="Reviewed Pull Requests">πŸ‘€</a> <a href="#tool-JoshuaKGoldberg" title="Tools">πŸ”§</a></td>
</tr>
</tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

[issues]: https://github.com/bradgarropy/eslint-config/issues
[codesandbox]: https://codesandbox.io
[kcd-pr]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
[license]: https://github.com/bradgarropy/eslint-config/blob/main/license
[fork]: https://github.com/bradgarropy/eslint-config/fork
[contributors]: https://github.com/bradgarropy/eslint-config#-contributors
Loading

0 comments on commit bc0cb59

Please sign in to comment.