Contributing to ToneCustoms Documentation
Thanks for helping improve the ToneCustoms documentation community.
This repository is dedicated to public documentation and community information. Contributions should make information more accurate, easier to find, or easier to understand.
Ways to Contribute
Report a Documentation Problem
Open a GitHub Issue using Documentation correction if you find:
- Incorrect or outdated text.
- Broken links.
- Missing context or unclear instructions.
- Grammar or formatting mistakes.
Identify the page or section, explain the issue, and suggest a correction where possible.
Suggest an Improvement
Use the Documentation suggestion issue template to recommend better organization, navigation, explanations, or accessibility.
For broader conversations, join ToneCustoms Discussions.
Quality checks before publication
Changes to the public docs are checked for broken links, restricted files and common credential patterns, and whether VitePress can build expected routes. Pull requests run these checks before maintainers merge when the workflow is enabled. The deploy workflow repeats the checks before publishing to GitHub Pages.
See Release Workflow for the process and responsibilities. These checks do not substitute for manual review or enforce merge blocking without repository branch rules.
Propose a Change
If you want to submit a correction through a pull request:
- Describe what you are changing and why.
- Keep the proposed change focused on documentation.
- Check links, spelling, and Markdown formatting.
- Explain any significant removal or reorganization.
- Use the repository's pull request template.
Maintainers review submissions and decide what gets merged. Proposing a change does not guarantee acceptance.
Writing Standards
ToneCustoms documentation should be:
- Clear: easy to follow without unnecessary jargon.
- Accurate: do not invent features, release dates, support commitments, or compatibility claims.
- Professional: respectful, concise, and focused on the reader.
- Consistent: use the ToneCustoms name and link only to verified official channels.
- Accessible: use descriptive headings and link labels.
Scope
This is not a resource distribution repository. Do not submit private source code, leaked content, paid files, license keys, credentials, or restricted assets.
This repository may document resources when the owner chooses to add that information; individual script uploads are not part of the contribution process.
Conduct & Security
All contributions must follow the ToneCustoms Community Guidelines.
If you notice a security concern, use the private reporting methods in SECURITY.md instead of posting sensitive information in an issue or discussion.
Official Community
ToneCustoms — Built for roleplay. Made with purpose.