Skip to content

Commit 597d14b

Browse files
Vinod KumarVinod Kumar
authored andcommitted
Created documenation for contribution guide.
- Fixed small issues in docs
1 parent e05f0f8 commit 597d14b

File tree

5 files changed

+17
-4
lines changed

5 files changed

+17
-4
lines changed

docs/contribution.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,10 @@ id: contribution
33
title: Contribution guide
44
---
55

6+
There are many ways you can help contribute make Universal React better.
7+
8+
1. Try running `npx create-universal-react` to setup you project.
9+
2. Report bugs and areas of improvements via [issus page](https://github.com/pagesource/universal-react-v2/issues).
10+
3. Raise additional feature requests from our community via [issus page](https://github.com/pagesource/universal-react-v2/issues).
11+
4. Raise pull request to solve existing problems.
12+
5. Contribute in development of [future road map](/universal-react-docs/docs/road-map/).

docs/features.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,6 @@ This accelerator is an highly opinionated collection of tools and best practices
2626
| Scaffolding | [Atomic Design](https://bradfrost.com/blog/post/atomic-web-design/) | No | No
2727
| Typesafe | [TypeScript](https://www.typescriptlang.org/). | Yes | No
2828
| Mocking | [GraphQl](https://graphql.org/) & REST APIs | Yes | Yes
29-
| Localization and Logging |NA | Yes | No
30-
| Code quality and formatting | Eslint, StyleLint and Prettier | Yes | No
29+
| Localization and Logging | NA | Yes | No
30+
| Code quality and formatting | Eslint, StyleLint and Prettier | Yes | No
31+
| VS Code Extensions | Recommended Extensions and Config | Yes | Yes

docs/quality-control.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,8 @@ title: Static Quality Control
77

88
Config packages to unify code linting and typescript configuration and rules across projects. No need to install those packages anymore in your each project and maintain them all separately, thanks to monorepo structure.
99

10-
![Linting config in Turborepo](/img/linting-config.png)
10+
![Linting config in Turborepo](/img/linting-config.png)
11+
12+
## End to End Testing Automation
13+
14+
Use simple JavaScript to write E2E tests and automate functional testing of your application with [TestCafe](https://testcafe.io/).

docs/road-map.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: road-map
33
title: Future road map
44
---
55

6-
There are many additional capabilities we are looking forward to add. Some of those are listed here in order of priority. We are open to take additional feature requests from out community through [issus page](https://github.com/pagesource/universal-react-v2/issues).
6+
There are many additional capabilities we are looking forward to add. Some of those are listed here in order of priority. We are open to take additional feature requests from our community through [issus page](https://github.com/pagesource/universal-react-v2/issues).
77

88
1. Configuration Management.
99
2. CI/CD Pipelines Templates.

docs/why.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ With **Reuse, Replicate and Reduce** philosophy at its core Universal React is
3636
| Quality control config | No | No | Yes
3737
| E2E automation | No | No | Yes, with Test Cafe
3838
| PWA | No | No | Yes, with Workbox
39+
| VS Code Config | No | No | Yes, extensions recommendations and config
3940

4041
## Impact and Efficiency
4142

0 commit comments

Comments
 (0)