-
-
Notifications
You must be signed in to change notification settings - Fork 3k
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: overhaul contributing and maintenance docs for end-of-year 2023 #5038
docs: overhaul contributing and maintenance docs for end-of-year 2023 #5038
Conversation
@@ -22,10 +22,11 @@ | |||
|
|||
## Links | |||
|
|||
- **[Documentation](https://mochajs.org/)** | |||
- **[Documentation](https://mochajs.org)** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A nitpick on my end: unnecessary trailing /
slashes at the end of URLs irritate me. 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Web server always assumes it's serving a file, unless the URL ends in a directory separator.
If the URL is to a directory, the server will append the directory index file (typically 'index.html') to the URL before it tries. If the server fails to return a file, it appends the directory separator to the path and retries as a directory.
Thus doing it this way causes twice the number of network calls needed for every directory URL without a trailing directory separator.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@plroebuck Thats something that eg Apache does internally – it’s not something done through multiple requests – and eg plain Node.js doesn’t do anything like that at all
@JoshuaKGoldberg Not sure I like this though, the one with the slash in the end is the more “correct” one 😜
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Haha how do we define "correct" here... per some specs the trailing slash is more correct. But end-users are generally told to visit URLs without saying the slash.
e1646ce
to
06ea75d
Compare
Looking good overall, will give it a proper review once I’m at a computer again (my bus was late so I’m reviewing from my phone in the winter cityscape 🥶) |
@JoshuaKGoldberg We should maybe investigate adding eg https://github.com/JoshuaKGoldberg/sentences-per-line later? To document / enforce such stylistic choices and making it easier for contributors to follow them? |
Didnt we want a "Checkbox I want to provide a PR" |
1. Repeated violators will be banned inasmuch as that is technically possible | ||
1. No maintainer nor contributor is exempt from the CoC | ||
|
||
## Branches | ||
|
||
`master` is the only maintained branch in `mochajs/mocha` or any of the other repos. **`master` is the only branch to which force-pushing is disallowed.** | ||
`master` is the only maintained branch in `mochajs/mocha` or any of the other repos. | ||
**`master` is the only branch to which force-pushing is disallowed.** | ||
|
||
Maintainers may push new branches to a repo, as long as they remove them when finished (merging a PR will prompt to do so). | ||
|
||
Please _please_ **_please_** delete old or unused branches. | ||
|
||
## Merging PRs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're discussing this now. Our consensus is:
- We don't believe the benefits of a pristine Git history to be worth the cost of asking everyone to maintain that history
- Squash merging PRs using their title + description preserves a relatively clean history
- We'll switch to squash merging always, and only enforcing conventions on the PR title
- We can therefore remove commit linting for anything other than file formatting
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
name: 📝 Documentation | ||
title: "📝 Documentation: <short description of the request>" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 shorter name good!
name: 📝 Documentation | |
title: "📝 Documentation: <short description of the request>" | |
name: 📝 Docs | |
title: "📝 Docs: <short description of the request>" |
Overview
Applies what I've personally found to be reasonable and usable contributing and maintenance processes as an iteration to the existing docs. Includes:
.github/DEVELOPMENT.md
out of.github/CONTRIBUTING.md
.md
templatesarea:
ortype:
prefixesunconfirmed-bug
to opting intostatus: ...
labels after triageDoes not include likely followups:
master
branch tomain
Fixes #5036. Fixes #5037.