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: streamline CONTRIBUTING.md and add DEVELOPMENT.md #5715

Merged
merged 6 commits into from
Oct 4, 2022
Merged

docs: streamline CONTRIBUTING.md and add DEVELOPMENT.md #5715

merged 6 commits into from
Oct 4, 2022

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Oct 2, 2022 •
edited
Loading

PR Checklist

Overview

Makes CONTRIBUTING.md much more compact by:

  • Trimming language in many places
  • Removing duplicate pleas for good behavior
  • Removing pleas for good behavior that have since become enforced by CI tooling (or reducing them to references to the tooling)
  • Splitting out development-specific information into a new dedicated DEVELOPMENT.md
  • Uses the "Do: ..." and/or "Don't: ..." format for concise lists where possible

Builds on the good changes contributed by @santoshyadavdev in #5595. 🚀

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@nx-cloud
Copy link

nx-cloud bot commented Oct 2, 2022 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b6859ac. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 from NxCloud.

@netlify
Copy link

netlify bot commented Oct 2, 2022 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit b6859ac
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/633c4db1e4d86a000970905c
😎 Deploy Preview https://deploy-preview-5715--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review October 2, 2022 08:23
bradzacher
bradzacher requested changes Oct 4, 2022
View reviewed changes
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

this is looking really good so far! A few comments

image

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Show resolved Hide resolved
DEVELOPMENT.md Show resolved Hide resolved
@bradzacher bradzacher added awaiting response Issues waiting for a reply from the OP or another party and removed awaiting response Issues waiting for a reply from the OP or another party labels Oct 4, 2022
@bradzacher bradzacher added 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge and removed awaiting response Issues waiting for a reply from the OP or another party labels Oct 4, 2022
@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) October 4, 2022 15:13
@codecov
Copy link

codecov bot commented Oct 4, 2022

Codecov Report

Merging #5715 (9c6b37c) into main (f373fac) will not change coverage.
The diff coverage is n/a.

❗ Current head 9c6b37c differs from pull request most recent head b6859ac. Consider uploading reports for the commit b6859ac to get more accurate results

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #5715   +/-   ##
=======================================
  Coverage   93.82%   93.82%           
=======================================
  Files         134      134           
  Lines        1506     1506           
  Branches      226      226           
=======================================
  Hits         1413     1413           
  Misses         60       60           
  Partials       33       33
Flag Coverage Δ
unittest 93.82% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
packages/scope-manager/src/scope/ScopeBase.ts 91.46% <0.00%> (ø)
packages/scope-manager/src/referencer/Reference.ts 88.00% <0.00%> (ø)
...ackages/scope-manager/src/variable/VariableBase.ts 100.00% <0.00%> (ø)
...ges/scope-manager/src/definition/DefinitionBase.ts 100.00% <0.00%> (ø)

@JoshuaKGoldberg JoshuaKGoldberg merged commit 71d6ed7 into typescript-eslint:main Oct 4, 2022
@JoshuaKGoldberg JoshuaKGoldberg deleted the streamlined-contributing branch October 4, 2022 16:38
@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.
Reviewers

@bradzacher bradzacher bradzacher approved these changes

Assignees
No one assigned
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Audit and streamline CONTRIBUTING.md
2 participants
@JoshuaKGoldberg @bradzacher