Skip to content

Commit 59d8ea6

Browse files
committed
docs: fix broken links
1 parent 6e2c3d5 commit 59d8ea6

File tree

3 files changed

+37
-37
lines changed

3 files changed

+37
-37
lines changed

CODE_OF_CONDUCT renamed to CODE_OF_CONDUCT.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ religion, or sexual identity and orientation.
1414
Examples of behavior that contributes to creating a positive environment
1515
include:
1616

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
2626
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
3030
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
31+
- Other conduct which could reasonably be considered inappropriate in a
3232
professional setting
3333

3434
## Our Responsibilities

CONTRIBUTING.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing
2+
3+
Hi there, thanks for being willing to contribute!
4+
5+
## Setup
6+
7+
- Fork and clone the repository
8+
- Install dependencies via via `npm install`
9+
- Create a new feature branch via `git checkout -b feature-branch-name`
10+
11+
## Testing
12+
13+
- Run `npm run test:lib` to test the library
14+
- Run `npm run test:app` to test the application
15+
- Run `npm run build` to build the library
16+
17+
## Push changes
18+
19+
- Add the files you want to push via `git add filename`, or add everything via `git add .`
20+
- Commit these changes locally and give it a proper description via `git commit -m "my changes here"`
21+
- Push these changes to your fork via `git push`
22+
- Create a new pull request
23+
24+
## Need some guidance?
25+
26+
- [GitHub help](https://help.github.com/)
27+
- [How to Contribute to an Open Source Project on GitHub - by Kent C. Dodds](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)

CONTRIBUTING.me

-27
This file was deleted.

0 commit comments

Comments
 (0)