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.

Sign up for GitHub

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

Jump to bottom

Docs: Audit and streamline CONTRIBUTING.md #5120

Closed
2 tasks done
JoshuaKGoldberg opened this issue May 31, 2022 · 2 comments · Fixed by #5595 or #5715
Closed
2 tasks done

Docs: Audit and streamline CONTRIBUTING.md #5120

JoshuaKGoldberg opened this issue May 31, 2022 · 2 comments · Fixed by #5595 or #5715
Assignees
@JoshuaKGoldberg
Labels
accepting prs Go ahead, send a pull request that resolves this issue repo maintenance things to do with maintenance of the repo, and not with code/docs

Comments

@JoshuaKGoldberg
Copy link
Member

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

It's been a while since we overhauled the CONTRIBUTING.md file. Lots has changed in the repo and we'll want to check what needs to be updated.

Furthermore, I'm finding the file to be pretty verbose as I read through it. We can probably streamline it a bit. Maybe use some <summary> tags to collapse sections. TBD!

Affected URL(s)

https://github.com/typescript-eslint/typescript-eslint/blob/main/CONTRIBUTING.md
@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for maintainers to take a look repo maintenance things to do with maintenance of the repo, and not with code/docs accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels May 31, 2022
@santoshyadavdev
Copy link
Contributor

Hey @JoshuaKGoldberg can I help with this, I have done some OSS and read through some contributing.md files, maybe I can help here.

@JoshuaKGoldberg
Copy link
Member Author

Awesome, thanks! I suspect it'll be helpful for someone who isn't on the maintainer crew to take a look, since you'll know better than us what is useful as an external contributor. Feel free to send a PR at whatever level of suggestion granularity you want. 🎉

santoshyadavdev added a commit to santoshyadavdev/typescript-eslint that referenced this issue Sep 3, 2022
@santoshyadavdev
docs: Audit and streamline CONTRIBUTING.md (typescript-eslint#5120)
5c58a02
@santoshyadavdev santoshyadavdev mentioned this issue Sep 3, 2022
Merged
3 tasks
santoshyadavdev added a commit to santoshyadavdev/typescript-eslint that referenced this issue Sep 3, 2022
@santoshyadavdev
docs: Audit and streamline CONTRIBUTING.md (typescript-eslint#5120)
dce56b4
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Sep 4, 2022
@santoshyadavdev santoshyadavdev mentioned this issue Sep 5, 2022
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Oct 2, 2022
Merged
3 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
accepting prs Go ahead, send a pull request that resolves this issue repo maintenance things to do with maintenance of the repo, and not with code/docs
Projects
None yet
Milestone
No milestone
2 participants
@JoshuaKGoldberg @santoshyadavdev