Skip to content

Commit 5602b03

Browse files
authored
docs(readme): add contributing section
And add codespaces to contributing gudelines as recommended option
1 parent 68f9332 commit 5602b03

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

CONTRIBUTING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ It is important to meet environment requirements in order to execute commands lo
3737

3838
There are 2 ways to do that:
3939

40-
1. Using docker you can boot a dev container and connect to it from VSCode using [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) which will have everything ready (Recommended)
41-
2. Manually install required dependencies on your local device:
40+
1. Use [Github Codespaces](https://docs.github.com/en/codespaces) to make changes directly online where everything is preconfigured (Recommended)
41+
2. Using docker you can boot a dev container and connect to it from VSCode using [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) which will have everything ready
42+
3. Manually install required dependencies on your local device:
4243
- Install NodeJS v16+
4344
- Install NPM v8+
4445

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
[![Greenkeeper badge](https://badges.greenkeeper.io/gund/ng-dynamic-component.svg)](https://greenkeeper.io/)
1414

1515
### Hey! There is a [proposal for new API](https://github.com/gund/ng-dynamic-component/discussions/484)!
16+
1617
So if you are using this library please give your vote/feedback.
1718

1819
<details>
@@ -434,6 +435,11 @@ To see example of how to implement custom component injector - see
434435
[`ComponentOutletInjectorDirective`](projects/ng-dynamic-component/src/lib/component-injector/component-outlet-injector.directive.ts)
435436
that is used to integrate `NgComponentOutlet` directive with inputs/outputs.
436437

438+
## Contributing
439+
440+
You are welcome to contribute to this project.
441+
Simply follow the [contribution guide](/CONTRIBUTING.md).
442+
437443
## License
438444

439445
MIT © [Alex Malkevich]([email protected])

0 commit comments

Comments
 (0)