Merge pull request #89 from Avdang-OS/dev

Small doc update

CONTRIBUTING.md

@@ -14,9 +14,10 @@ We use Prettier as formatter. All jsx naming should follow Airbnb style, and all
 
 ## Basics
 
-To start your contribution follow the steps below
+To start your contribution, please follow the steps below
 
 1. Create a fork of this repo
+
 2. Git clone your fork to your machine
 
 ```sh
@@ -47,7 +48,7 @@ You can now go to https://localhost:3000 in your browser and it will update in r
 
 `Tip: test pages on smaller width and both themes to make sure they have good compatibility. In the lib folder, there's dynamic-width.ts, which is an easy to use hook we made with full jsdoc documentation`
 
-6. Commit your changes
+7. Commit your changes
 
 ```sh
 git commit -m "concise message of the change"
@@ -65,28 +66,24 @@ git push
 
 ## Pull Requests
 
- It would help the review process go faster if you list changes in the pull request, with the exception of a single small change in the title and nothing in comment. List of changes should be concise but meaningful
+To make the review process faster, it's recommended to have list of changes in comment section and include screenshots if there are changes in the design. List of changes should be concise.
 
 > [nothing]
 
 ❌ : What did you change? Reviewer need to guess what your code does
 
 > Make browsing experience better on mobile
 
-❌ : better is subjective, and we still don't know what you did
+❌ : Better is subjective, and we still don't know what you did
 
 > Make pages respond to mobile screen
 
-Meh : it's acceptable
+Meh: It's acceptable
 
 > Footer: implement adaptive layout on small screen
 
-✔️ : Now we know why a file changed and what it's suppose to do.
-
-Bad pull request messages won't cause it to get closed, but better messages will speed up the process and make merging faster. 
-
-If there's a change in design, please also include a screenshot in the pull request.
+✅ : Now we know why a file changed and what it's suppose to do.
 
-Since commits to the dev branch will automatically get deployed, please make sure all pull requests are complete. You can create draft pull requests, which will allow other people to see, give feedbacks, and request changes.
+Since commits to the dev branch will automatically get deployed, please make sure all pull requests are complete. Run `npm run build` in the src directory to double check there is no error. You can create draft pull requests, which will allow other people to see changes, give feedbacks, and request changes.
 
-Even if you're in the organisation, code should be reviewed and approved by another member before merging, with exceptions of fixing a build fail or security breach. Complete redesign of an existing webpage will need approval from team lead.
+Even if you're in the organisation, pull requests should be reviewed and approved by another member before merging, with exceptions of fixing a build fail or security breach. Complete redesign of an existing webpage will need approval from a team lead.

README.md

@@ -36,24 +36,6 @@ The page will reload if you make edits.
 
 You will also see any lint errors in the console.
 
-## Contribution
+## Contributing
 
-### Compatibility
-
-Makesure everything works on mobile before merging. To make a page compatible with all width, there is a hook `'@/lib/dynamic-width'` import it and use it to make the page adaptive.
-
-Also, test on at least two browser engines (eg. Firefox with gecko engine and Brave based on Chromium project).
-
-If things don't fully work and you want to release a beta to the public, you can also make the page opt in beta page (see the BetaPopup component) or show a warning message (indecating to the user that it is likely to break).
-
-If you are making a page without the help of any designer or other developers, try to follow the design. This can be easily done by using the geist-ui and not change too much properties.
-
-### Code Quality
-
-For tsx, please follow the [Airbnb style guide](https://airbnb.io/javascript/react/). For CSS, please follow [this guide](https://www.freecodecamp.org/news/css-naming-conventions-that-will-save-you-hours-of-debugging-35cea737d849/).
-
-### Pull Request
-
-It's recommended that you have a concise list of change when making pull request to make the review process faster. Also, makesure the page builds on your fork before making a pull request.
-
-Again, **remember to use dev branch!!!** Committing to master branch will be automatically overwritten.
+Please see the [contributing guideline](https://github.com/Avdan-OS/Website/blob/dev/CONTRIBUTING.md) for more information.