8000 Docs: Add CONTRIBUTING and update README by thien-do · Pull Request #235 · thien-do/moai · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Docs: Add CONTRIBUTING and update README #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 28, 2021
Merged

Docs: Add CONTRIBUTING and update README #235

merged 4 commits into from
Jun 28, 2021

Conversation

thien-do
Copy link
Owner
@thien-do thien-do commented Jun 27, 2021

This PR adds:

and update:

(click on the file name to preview them in HTML)

Fixes #144 Fixes #232

@thien-do thien-do requested a review from monodyle June 27, 2021 00:37
@vercel
Copy link
vercel bot commented Jun 27, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

moai-docs – ./lib/docs

🔍 Inspect: https://vercel.com/makeinvietnam/moai-docs/FaxgYrtxyKZyVa7HU4vELhnU7YPV
✅ Preview: https://moai-docs-git-fork-thien-do-contributing-makeinvietnam.vercel.app

moai-site – ./site

🔍 Inspect: https://vercel.com/makeinvietnam/moai-site/A9Mqa7CHPhUJm6PvtrPygxi5LyJt
✅ Preview: https://moai-site-git-fork-thien-do-contributing-makeinvietnam.vercel.app

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should specify version of environment and framework tools to develop. E.g: version of node, yarn,... to ensure contributor setup correctly.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor
@lqt93 lqt93 Jun 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor
@lqt93 lqt93 Jun 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about putting webuild badge or madeinvietnam badge to be displayed in curated list of webuild? It is a good way to marketing.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm interesting, I think I should

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor
@tuhuynh27 tuhuynh27 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

- 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.
![Moai preview](https://user-images.githubusercontent.com/5953369/123528873-5b3de480-d715-11eb-8c02-50a04f2d83f9.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just really not enjoy this preview image, the default macOS screenshot shadow too strong... Recommend remove the shadow or just took UI kits.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggestion, I'll take another one with my wallpaper

@thien-do thien-do merged commit 0f9898e into thien-do:main Jun 28, 2021
@thien-do thien-do deleted the contributing branch June 28, 2021 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README.md Write CONTRIBUTING.md
4 participants
0