Skip to content

Commit

Permalink
docs: add contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
azat-io committed Jun 4, 2023
1 parent aaa446a commit a8c517a
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@
- [ ] Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
- [ ] Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`).
- [ ] Ideally, include relevant tests that fail without this PR but pass with it.
- [ ] Read [contribution guidelines](https://github.com/azat-io/eslint-plugin-perfectionist/blob/main/contributing.md).
41 changes: 41 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing

Hello! It's great that you are interested in contributing to ESLint Plugin Perfectionist. Before submitting your contribution, please take a moment to read the following guide:

## Installation

This project uses the [pnpm](https://pnpm.io) package manager. Therefore, to work with the project, you need to install it.

How to set up a project locally and run tests:

1. Clone repo:

```sh
git clone [email protected]:azat-io/eslint-plugin-perfectionist.git
```

2. Install dependencies:

```sh
pnpm install
```

3. Run tests:

```sh
pnpm test
```

## Pull Request Guidelines

Before create pull request fork this repo and create a new branch.

ESLint Plugin Perfectionist aims to be lightweight, so think before adding new dependencies to your project.

Commit messages must follow the [commit message convention](https://conventionalcommits.org/) so that changelogs can be automatically generated.

Make sure tests pass.

## Additional information

This plugin uses [@typescript/eslint-parser](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/parser). When developing, I recommend using [AST explorer](https://astexplorer.net). It makes development much easier.
7 changes: 6 additions & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { SitemapStream } from 'sitemap'
import path from 'path'

import {
contributing,
description,
changelog,
keywords,
Expand Down Expand Up @@ -187,9 +188,13 @@ export default defineConfig({
text: `v${version}`,
items: [
{
text: 'Changelog ',
text: 'Changelog',
link: changelog,
},
{
text: 'Contributing',
link: contributing,
},
],
},
],
Expand Down
2 changes: 2 additions & 0 deletions docs/.vitepress/meta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ export let github = `https://github.com/${repository}`

export let changelog = `${github}/blob/main/changelog.md`

export let contributing = `${github}/blob/main/contributing.md`

export let image = `${homepage}/open-graph.png`

0 comments on commit a8c517a

Please sign in to comment.