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: overhaul contributing and maintenance docs for end-of-year 2023 #5038

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Dec 2, 2023

Overview

Applies what I've personally found to be reasonable and usable contributing and maintenance processes as an iteration to the existing docs. Includes:

  • General docs:
  • Issues:
    • Added two new issue types: documentation and repository tooling
    • Disabled filing a new blank issue
    • Streamlined the contents of the issue templates a bit, and added some emojis
    • Used the new GitHub Issue Forms instead of .md templates
  • Pull requests:
    • Streamlined the template
  • Labels:
    • Renaming labels to include area: or type: prefixes
    • Switching from needing an explicit unconfirmed-bug to opting into status: ... labels after triage
  • Switching from the old Gitter to a new Discord
  • Switching from requiring rebasing to merging

Does not include likely followups:

  • Renaming the master branch to main
  • Enforcing any formatting/spellchecking/style with any new tooling
  • Set up commit/PR linting to enforce PR titles and nothing else, per squash merging

Fixes #5036. Fixes #5037.

@@ -22,10 +22,11 @@

## Links

- **[Documentation](https://mochajs.org/)**
- **[Documentation](https://mochajs.org)**
Copy link
Member Author

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. 😄

Copy link
Contributor

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.

Apache: Mapping URLs to Filesystem Locations #DocumentRoot

Copy link
Member

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 😜

Copy link
Member Author

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.

@JoshuaKGoldberg JoshuaKGoldberg force-pushed the overhaul-contributing-and-maintenance-docs branch from e1646ce to 06ea75d Compare December 2, 2023 15:38
@coveralls
Copy link

coveralls commented Dec 2, 2023

Coverage Status

coverage: 94.337%. remained the same
when pulling 7142832 on JoshuaKGoldberg:overhaul-contributing-and-maintenance-docs
into b41e985 on mochajs:master.

@voxpelli
Copy link
Member

voxpelli commented Dec 3, 2023

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 🥶)

@voxpelli
Copy link
Member

voxpelli commented Dec 3, 2023

@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?

@Uzlopak
Copy link
Member

Uzlopak commented Dec 5, 2023

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
Copy link
Member Author

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:

  1. We don't believe the benefits of a pristine Git history to be worth the cost of asking everyone to maintain that history
  2. Squash merging PRs using their title + description preserves a relatively clean history
  3. We'll switch to squash merging always, and only enforcing conventions on the PR title
  4. We can therefore remove commit linting for anything other than file formatting

Copy link
Member

@Uzlopak Uzlopak left a comment

Choose a reason for hiding this comment

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

LGTM

Comment on lines 25 to 26
name: 📝 Documentation
title: "📝 Documentation: <short description of the request>"
Copy link
Member Author

Choose a reason for hiding this comment

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

💡 shorter name good!

Suggested change
name: 📝 Documentation
title: "📝 Documentation: <short description of the request>"
name: 📝 Docs
title: "📝 Docs: <short description of the request>"

This was referenced Aug 18, 2024
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.

Revisit and overhaul existing maintenance docs Overhaul issue and PR templates
5 participants