Skip to content

Commit 5153c28

Browse files
committed
docs(contributing): update contributing instructions
1 parent aaaf2b7 commit 5153c28

File tree

1 file changed

+4
-15
lines changed

1 file changed

+4
-15
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,6 @@
1-
We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏
1+
# Contributing
22

3-
## Instructions
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
45

5-
These steps will guide you through contributing to this project:
6-
7-
- Fork the repo
8-
- Clone it and install dependencies
9-
10-
git clone https://github.com/YOUR-USERNAME/typescript-library-starter
11-
npm install
12-
13-
Keep in mind that after running `npm install` the git repo is reset. So a good way to cope with this is to have a copy of the folder to push the changes, and the other to try them.
14-
15-
Make and commit your changes. Make sure the commands npm run build and npm run test:prod are working.
16-
17-
Finally send a [GitHub Pull Request](https://github.com/alexjoverm/typescript-library-starter/compare?expand=1) with a clear list of what you've done (read more [about pull requests](https://help.github.com/articles/about-pull-requests/)). Make sure all of your commits are atomic (one feature per commit).
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.

0 commit comments

Comments
 (0)