Docs: Add CONTRIBUTING and update README #235
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). moai-docs – ./lib/docs🔍 Inspect: https://vercel.com/makeinvietnam/moai-docs/FaxgYrtxyKZyVa7HU4vELhnU7YPV moai-site – ./site🔍 Inspect: https://vercel.com/makeinvietnam/moai-site/A9Mqa7CHPhUJm6PvtrPygxi5LyJt |
| yarn start | ||
| ``` | ||
|
|
||
| Note that you don't need to run `yarn` first. We intentionally prefixed `yarn start` with `yarn` to ensure you always work on the correct dependencies. |
There was a problem hiding this comment.
I think we should specify version of environment and framework tools to develop. E.g: version of node, yarn,... to ensure contributor setup correctly.
There was a problem hiding this comment.
I don't think it would help much, since it works with both yarn 1 and yarn 2, and compatible with the last 2 LTS version of nodejs
There was a problem hiding this comment.
But what if contributor use an old version of node that cannot load some of the dependencies. At least we should specify the most lowest version that can work well.
I got a situation like that when working with vim.md, there were changes that required me to upgrade node to v14 to run while I was trying with node v12.
There was a problem hiding this comment.
oh that's bad. Ok I'll put the node and yarn version :D
| - [Design Principles](https://docs.moaijs.com/?path=/docs/intro-principles--page): The unique traits that lead Moai's design and development. | ||
| - [Development](./.github/DEVELOP.md): Codebase overview and local development setup. | ||
| - [Code of Conduct](./.github/CODE_OF_CONDUCT.md): How we treat each other. | ||
|
|
There was a problem hiding this comment.
How about putting webuild badge or madeinvietnam badge to be displayed in curated list of webuild? It is a good way to marketing.
There was a problem hiding this comment.
Hm interesting, I think I should
There was a problem hiding this comment.
OK @lqt93 I've just looked around and there are also other badges I'd like to add. Will add them all in another PR
| - In Next.js, we recommend the [`next-themes`] package. It allows your users | ||
| to change the theme, including a "system" option, without any flashing in | ||
| initial render. | ||
|  |
There was a problem hiding this comment.
I just really not enjoy this preview image, the default macOS screenshot shadow too strong... Recommend remove the shadow or just took UI kits.
There was a problem hiding this comment.
Good suggestion, I'll take another one with my wallpaper
This PR adds:
and update:
(click on the file name to preview them in HTML)
Fixes #144 Fixes #232