Skip to content

Commit d5823f7

Browse files
paambaatipaambaati
committed
docs: add basic docs
1 parent cb1511f commit d5823f7

File tree

2 files changed

+127
-0
lines changed

2 files changed

+127
-0
lines changed

‎CONTRIBUTING.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Contributing to this project <!-- omit in toc -->
2+
3+
## Getting started <!-- omit in toc -->
4+
5+
Before you begin –
6+
7+
- Install the latest stable version of [Node.js](https://nodejs.org/)
8+
- Clone this repository using `git clone [email protected]:getoslash/eslint-plugin-tap.git`
9+
- Install all dependencies using `npm install`
10+
11+
### Linting code
12+
13+
To check if your code is lint-free, run the command –
14+
15+
```
16+
npm run lint
17+
```
18+
19+
To try to auto-fix issues, run the command –
20+
21+
```
22+
npm run lint:fix
23+
```
24+
25+
To ensure all your TypeScript code is compliant, run the command –
26+
27+
```
28+
npm run typecheck
29+
```
30+
31+
### Running all tests
32+
33+
To run all tests, run the command –
34+
35+
```
36+
npm run test
37+
```
38+
39+
### Creating your first issue
40+
41+
Before you make your changes, check to see if an
42+
[issue exists](https://github.com/getoslash/eslint-plugin-tap/issues/) already
43+
for the change you want to make.
44+
45+
### Don't see your issue? Open one
46+
47+
If you spot something new, open an issue using a
48+
[template](https://github.com/getoslash/eslint-plugin-tap/issues/new/choose).
49+
We'll use the issue to have a conversation about the problem you want to fix.
50+
51+
### Ready to make a change? Fork the repo
52+
53+
Fork using GitHub Desktop:
54+
55+
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop)
56+
will guide you through setting up Desktop.
57+
- Once Desktop is set up, you can use it to
58+
[fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
59+
60+
Fork using the command line:
61+
62+
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository)
63+
so that you can make your changes without affecting the original project until
64+
you're ready to merge them.
65+
66+
Fork with [GitHub Codespaces](https://github.com/features/codespaces):
67+
68+
- [Fork, edit, and preview](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace)
69+
using [GitHub Codespaces](https://github.com/features/codespaces) without
70+
having to install and run the project locally.
71+
72+
### Make your update
73+
74+
Make your changes to the file(s) you'd like to update.
75+
76+
- Are you making changes to the application code? You'll need Node.js to
77+
run the tests locally.
78+
- Are you contributing to markdown? We use
79+
[GitHub Markdown](contributing/content-markup-reference.md).
80+
- Writing a Git commit message? We use the [Angular commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular#readme).
81+
82+
### Open a pull request
83+
84+
When you're done making changes and you'd like to propose them for review, use
85+
the [pull request template](#pull-request-template) to open your PR (pull
86+
request).
87+
88+
### Submit your PR & get it reviewed
89+
90+
- Once you submit your PR, project members will review it with you. The first
91+
thing you're going to want to do is a self review.
92+
- After that, we may have questions, check back on your PR to keep up with the
93+
conversation.
94+
- Did you have an issue, like a merge conflict? Check out GitHub's
95+
[git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts)
96+
on how to resolve merge conflicts and other issues.
97+
98+
### Your PR is merged!
99+
100+
Congratulations! OSlash and the whole open-source community thanks you.
101+
:sparkles:
102+
103+
Once your PR is merged, you will be proudly listed as a contributor in the
104+
[contributor chart](https://github.com/getoslash/eslint-plugin-tap/graphs/contributors).

‎LICENSE

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
The MIT License (MIT)
2+
3+
Original work Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com)
4+
Modified work Copyright 2016 Abel Toledano <[email protected]>
5+
Modified work Copyright 2021 OSlash <[email protected]>
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy
8+
of this software and associated documentation files (the "Software"), to deal
9+
in the Software without restriction, including without limitation the rights
10+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the Software is
12+
furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included in
15+
all copies or substantial portions of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23+
THE SOFTWARE.

0 commit comments

Comments
 (0)