Create CONTRIBUTING.md#6193
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation changes
adds a contributing.md file
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Note
Low Risk
Adds contributor-facing markdown only; no runtime, auth, or product behavior changes.
Overview
Adds a new
CONTRIBUTING.mdat the repo root so external contributors know how to work on Mintlify documentation.The guide covers what to submit (fixes, gaps) versus what is out of scope (tone-only edits, site structure), writing style, and workflow for issues and PRs (including routing bugs and feature requests away from this repo). It also sets expectations for reviews, AI use (allowed for PR help, not bulk commits or AI-opened issues), and a full Code of Conduct (Contributor Covenant 3.0) with reporting via support@mintlify.com and an enforcement ladder.
This is documentation-only; published docs already treat
CONTRIBUTING.mdas mintignored by default.Reviewed by Cursor Bugbot for commit 11ca07a. Bugbot is set up for automated code reviews on this repo. Configure here.