Skip to content

Commit 11c2c5a

Browse files
committed
updated contribution guide
1 parent 8234a8a commit 11c2c5a

File tree

10 files changed

+29
-38
lines changed

10 files changed

+29
-38
lines changed

CHANGELOG.md

-11
This file was deleted.

CONTRIBUTION.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Contribution Guide
2+
- Before submitting a PR please create an issue to discuss it first (also make sure you have read **Goals** section)
3+
- Don't edit `README.md` directly - it is built using `sh ./generate.sh` script to inject code snippets from the sources in the `/playground` folder (this will make sure all code examples are nicely formatted and working)
4+
- To make changes in `README.md` edit `.md` files that are located in the `/docs/markdown` folder
5+
- To make changes in code snippets edit source files in `/playground` folder
6+
- include directives look like this: `::[example|usage]='../../playground/src/components/sfc-counter.tsx'::`
7+
8+
When submitting a PR please make sure that you run:
9+
```bash
10+
# run linter in `/playground` folder
11+
npm run lint
12+
13+
# run type-checking in `/playground` folder
14+
npm run tsc
15+
16+
# always re-generate `README.md` from root folder
17+
sh ./generate.sh
18+
# don't like bash scripts? simply use node.js script
19+
# node ./generator/bin/generate-readme.js
20+
```

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2016 Piotr Witek
3+
Copyright (c) 2016 Piotr Witek <piotrek.witek@gmail.com> (http://piotrwitek.github.io)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

docs/markdown/6_end.md

-20
This file was deleted.
File renamed without changes.

docs/markdown/7_end.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
MIT License
2+
3+
Copyright (c) 2017 Piotr Witek <piotrek.witek@gmail.com> (http://piotrwitek.github.io)

docs/markdown/_toc.md

-1
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,4 @@
2828
- [Vendor Types Augmentation](#vendor-types-augmentation)
2929
- [Default and Named Module Exports](#default-and-named-module-exports)
3030
- [FAQ](#faq)
31-
- [Contribution Guide](#contribution-guide)
3231
- [Tutorials](#tutorials)

generator/bin/generate-readme.js

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

generator/bin/generate-readme.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

generator/src/generate-readme.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ const inputFiles = [
1313
DOCS_PATH + '3_tools.md',
1414
DOCS_PATH + '4_recipes.md',
1515
DOCS_PATH + '5_faq.md',
16-
DOCS_PATH + '6_end.md',
17-
DOCS_PATH + '7_links.md',
16+
DOCS_PATH + '6_links.md',
17+
DOCS_PATH + '7_end.md',
1818
];
1919

2020
const outputFile = TOP_LEVEL_PATH + 'README.md';

0 commit comments

Comments
 (0)