Skip to content

Commit b30ed6a

Browse files
authored
docs: update CONTRIBUTING.md (#1132)
* docs: update CONTRIBUTING.md * docs: update headings
1 parent c538a1a commit b30ed6a

1 file changed

Lines changed: 50 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
## Notice to external contributors
2-
### General info
1+
# Contribution guide
2+
3+
### Legal info
4+
35
Hello! In order for us (YANDEX LLC) to accept patches and other contributions from you, you will have to adopt our Contributor License Agreement (the “CLA”). The current version of the CLA you may find here:
46

57
* https://yandex.ru/legal/cla/?lang=en (in English)
@@ -39,16 +41,57 @@ If you have any questions, please write us at opensource@yandex-team.ru .
3941
* if an issue describes a problem which we are unable to reproduce and issue reporter does not answer our questions for 1 week, then this issue may be closed without further investigation.
4042

4143
## How to develop
42-
### Create your own copy
43-
```
44-
git clone https://github.com/gemini-testing/testplane.git
44+
45+
### Create your own copy of Testplane repo
46+
47+
**Note.** If you are not a member of gemini-testing and going to submit a PR, you should first create a fork of Testplane repo.
48+
49+
```bash
50+
git clone https://github.com/gemini-testing/testplane.git # Replace with your fork URL
4551
cd testplane
4652
npm install
4753
```
4854

49-
**Note.** It's better to create a fork, if you plan to make a pull request.
55+
### Create a test project
56+
57+
When working with testplane, you'd want to test your changes on a real project as if you were a user.
5058

51-
### Run tests
59+
To create a test project, use our CLI wizard:
60+
61+
```
62+
npm init testplane@latest testplane-test-project
5263
```
64+
65+
This will create a project in `testplane-test-project` directory.
66+
67+
### Link your local Testplane repo to your test project
68+
69+
Go to Testplane repo directory and run:
70+
71+
```shell
72+
cd testplane
73+
npm link
74+
```
75+
76+
Then go to your test project's directory and run:
77+
78+
```shell
79+
cd testplane-test-project
80+
npm link testplane
81+
```
82+
83+
### Build testplane
84+
85+
To build testplane, you may use `npm run build` command or `npm run watch` to watch for changes.
86+
87+
Great! Now you have everything set up. You can now make some tweaks in testplane and run `npx testplane` in your test project to see how it works with your changes!
88+
89+
### Run checks locally
90+
91+
You may run all linters and tests locally using the command below.
92+
93+
```shell
5394
npm test
5495
```
96+
97+
For a more granular checks, see scripts section in `package.json`.

0 commit comments

Comments
 (0)