Skip to content

Improve CONTRIBUTING document #356

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
Closed
Belco90 opened this issue Apr 25, 2021 · 2 comments · Fixed by #419
Closed

Improve CONTRIBUTING document #356

Belco90 opened this issue Apr 25, 2021 · 2 comments · Fixed by #419
Labels
documentation Improvements or additions to documentation pinned Pinned for different reasons. Issues with this label won't be flagged as stale by stalebot released

Comments

@Belco90
Copy link
Member

Belco90 commented Apr 25, 2021

Some ideas for improving our CONTRIBUTING.md with:

  • some AST info
  • some link to astexplorer.net as a tool to deal with AST
  • new section about how to try changes locally

Feedback from @zaicevas:

For the first 30 minutes I had no idea where to start, until I've realized it's all based on AST and found https://astexplorer.net/
After that it all started to make sense and the code proved to be very clear & extendable. Perhaps it could be useful mentioning this or other similar tools in https://github.com/testing-library/eslint-plugin-testing-library/blob/main/CONTRIBUTING.md

Another that I think could be of use in CONTRIBUTING.md is a section on how to try out changes locally (besides tests). I suppose symlinking with yarn link or npm link is relatively simple and could work here.

Originally posted by @zaicevas in #352 (comment)
@Belco90 Belco90 added the documentation Improvements or additions to documentation label Apr 25, 2021
@stale
Copy link

stale bot commented Jun 24, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Jun 24, 2021
@MichaelDeBoey MichaelDeBoey added pinned Pinned for different reasons. Issues with this label won't be flagged as stale by stalebot and removed wontfix This will not be worked on labels Jun 24, 2021
@zaicevas zaicevas mentioned this issue Jul 19, 2021
Merged
Belco90 pushed a commit that referenced this issue Jul 20, 2021
@zaicevas
docs: improve CONTRIBUTING (#419)
5dff88e 
* feat: improve contributing docs

* fix: add missing link

Closes #356
@github-actions
Copy link

🎉 This issue has been resolved in version 4.9.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation pinned Pinned for different reasons. Issues with this label won't be flagged as stale by stalebot released
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: improve CONTRIBUTING zaicevas/eslint-plugin-testing-library
2 participants
@Belco90 @MichaelDeBoey