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: add "Contributing" section #1233

Merged
merged 5 commits into from
Jun 18, 2023
Merged

docs: add "Contributing" section #1233

merged 5 commits into from
Jun 18, 2023

Conversation

iuioiua
Copy link
Contributor

@iuioiua iuioiua commented Jun 1, 2023

This just copies the main repo, which does the job.

@iuioiua iuioiua requested a review from lucacasonato June 1, 2023 01:25
@iuioiua iuioiua mentioned this pull request Jun 1, 2023
@lucacasonato
Copy link
Member

Can you add a section to the manual about "Contributing to fresh" with instructions on tests, fmt, and lint?

@deer
Copy link
Contributor

deer commented Jun 10, 2023

I was thinking of working on #657, but then I saw this. Please close the issue once this is merged. I'd also suggest the link in README.md be changed to https://deno.com/manual/references/contributing#submitting-a-pr-to-fresh, so that people are taken to exactly the right place.

There's also the two closed #465 and #658. Before I delete my branch that introduces a CONTRIBUTING.md file (because what you have here seems like the preferred approach, I'd still recommend some sort of tips section. I had...

- [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#summary)
  are great when titling your PR.
- Tests, documentation, and examples always help to provide extra context.
- You'll likely need to install
  [deno-puppeteer](https://github.com/lucacasonato/deno-puppeteer#installation)
  in order to run the tests.

@iuioiua
Copy link
Contributor Author

iuioiua commented Jun 11, 2023

I was thinking of working on #657, but then I saw this. Please close the issue once this is merged. I'd also suggest the link in README.md be changed to https://deno.com/manual/references/contributing#submitting-a-pr-to-fresh, so that people are taken to exactly the right place.

Done and done.

Good idea. But this repo isn't the place to do that. I instead created an issue with this suggestion in the manual repo (here).

  • Tests, documentation, and examples always help to provide extra context.

Maybe let's get this PR landed first. We can explore how we can improve instructions in an issue or PR after.

  • You'll likely need to install deno-puppeteer in order to run the tests.

I believe this is done anyway upon running deno task test

Ok, I'll add that in.

@iuioiua
Copy link
Contributor Author

iuioiua commented Jun 13, 2023

This PR is ready for review.

@deer
Copy link
Contributor

deer commented Jun 14, 2023

@iuioiua
Copy link
Contributor Author

iuioiua commented Jun 14, 2023

Doh! Will fix 🥲

@iuioiua
Copy link
Contributor Author

iuioiua commented Jun 15, 2023

@marvinhagemeister, PTAL. I'll fix the typo mentioned in #1233 (comment) independently.

@deer
Copy link
Contributor

deer commented Jun 17, 2023

@marvinhagemeister Looks like this was inadvertently closed when manual#681 was merged.

@marvinhagemeister marvinhagemeister merged commit d0b277a into main Jun 18, 2023
@marvinhagemeister marvinhagemeister deleted the contributing branch June 18, 2023 11:42
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