Skip to content

Commit

Permalink
Created documenation for contribution guide.
Browse files Browse the repository at this point in the history
- Fixed small issues in docs
  • Loading branch information
Vinod Kumar authored and Vinod Kumar committed Jun 7, 2022
1 parent e05f0f8 commit 597d14b
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 4 deletions.
7 changes: 7 additions & 0 deletions docs/contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,10 @@ id: contribution
title: Contribution guide
---

There are many ways you can help contribute make Universal React better.

1. Try running `npx create-universal-react` to setup you project.
2. Report bugs and areas of improvements via [issus page](https://github.com/pagesource/universal-react-v2/issues).
3. Raise additional feature requests from our community via [issus page](https://github.com/pagesource/universal-react-v2/issues).
4. Raise pull request to solve existing problems.
5. Contribute in development of [future road map](/universal-react-docs/docs/road-map/).
5 changes: 3 additions & 2 deletions docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@ This accelerator is an highly opinionated collection of tools and best practices
| Scaffolding | [Atomic Design](https://bradfrost.com/blog/post/atomic-web-design/) | No | No
| Typesafe | [TypeScript](https://www.typescriptlang.org/). | Yes | No
| Mocking | [GraphQl](https://graphql.org/) & REST APIs | Yes | Yes
| Localization and Logging |NA | Yes | No
| Code quality and formatting | Eslint, StyleLint and Prettier | Yes | No
| Localization and Logging | NA | Yes | No
| Code quality and formatting | Eslint, StyleLint and Prettier | Yes | No
| VS Code Extensions | Recommended Extensions and Config | Yes | Yes
6 changes: 5 additions & 1 deletion docs/quality-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,8 @@ title: Static Quality Control

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.

![Linting config in Turborepo](/img/linting-config.png)
![Linting config in Turborepo](/img/linting-config.png)

## End to End Testing Automation

Use simple JavaScript to write E2E tests and automate functional testing of your application with [TestCafe](https://testcafe.io/).
2 changes: 1 addition & 1 deletion docs/road-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: road-map
title: Future road map
---

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).
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).

1. Configuration Management.
2. CI/CD Pipelines Templates.
Expand Down
1 change: 1 addition & 0 deletions docs/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ With **Reuse, Replicate and Reduce** philosophy at its core Universal React is
| Quality control config | No | No | Yes
| E2E automation | No | No | Yes, with Test Cafe
| PWA | No | No | Yes, with Workbox
| VS Code Config | No | No | Yes, extensions recommendations and config

## Impact and Efficiency

Expand Down

0 comments on commit 597d14b

Please sign in to comment.