Skip to content
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

docs: enhance the contributing docs, and clean up README #8

Merged
merged 4 commits into from
Sep 26, 2022

Conversation

machour
Copy link
Collaborator

@machour machour commented Sep 17, 2022

I expanded the contributing guide for this particular repo in CONTRIBUTING.md, since this might be a first OSS contribution for some.

Also refreshed the README a bit


```
npx create-remix@latest --template https://github.com/remix-run/examples/tree/main/<example-dir>
npx create-remix@latest --template examples/<example-dir>
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This will work again when remix-run/remix#4208 is merged

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
machour and others added 3 commits September 17, 2022 15:26
Co-authored-by: Michaël De Boey <[email protected]>
Co-authored-by: Michaël De Boey <[email protected]>
Copy link
Collaborator

@chaance chaance left a comment

Choose a reason for hiding this comment

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

Great edits, thank you!

@chaance chaance merged commit 82a2545 into remix-run:main Sep 26, 2022
@machour machour deleted the docs/enhance-contributing branch September 26, 2022 23:00
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.

4 participants