Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (25 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 1.55 KB

Contributing to disttopic.github.io

Thank you for helping improve the DistTopic website!

Ways to contribute

  • Edit an existing page — click "Edit this page on GitHub" at the bottom of any page
  • Add a new page — create a .md file in the appropriate folder
  • Fix a typo or broken link — open a pull request directly
  • Report an issue — open an issue describing the problem

No local setup needed

All content is Markdown. You can create and edit pages directly from GitHub's web UI without cloning the repository.

For detailed instructions on Markdown syntax, front matter, and page structure, see the Adding & Editing Pages guide.

Pull request process

  1. Fork the repository (or create a branch if you have write access)
  2. Create your changes
  3. Open a pull request against main
  4. A maintainer will review and merge

Content guidelines

  • Write in clear, concise English
  • Use the present tense ("The editor supports..." not "The editor will support...")
  • Keep security notes accurate — if in doubt, open an issue before editing
  • Do not add inline <script> tags or external resource links (they will be blocked by CSP)
  • Keep images in assets/images/ as SVG or well-compressed rasters; do not hotlink external images

Code of conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold it.

Security issues

Do not open public issues for security vulnerabilities. See SECURITY.md.