Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 2.17 KB

File metadata and controls

44 lines (33 loc) · 2.17 KB

Contributing to Wiki

First off, thank you for considering contributing to this repository! It's people like you that make the open-source community such an amazing place to learn, inspire, and create.

This repository is a personal knowledge base, but I welcome contributions that improve the quality of existing information, add new valuable sections, or enhance the platform's functionality.

🌈 How Can I Contribute?

Reporting Bugs

If you find a broken link, a technical error in the Docusaurus setup, or a typo in the documentation, please open an issue.

Suggesting Enhancements

Suggestions for new domains, tool recommendations, or UI improvements are always welcome. Please use the "Feature Request" issue template.

Documentation Contributions

If you want to add a new document or update an existing one:

  1. Fork the repository.
  2. Create a new branch: git checkout -b docs/your-topic-name.
  3. Make your changes in the docs/ directory.
    • Use proper frontmatter (title, sidebar_position).
    • Ensure you use semantic HTML and descriptive headings.
  4. Submit a Pull Request.

Code Contributions

For improvements to the site structure, scripts (like the mindmap generator), or styling:

  1. Ensure your code follows the existing style patterns.
  2. Run yarn build locally to ensure no build errors are introduced.
  3. Submit a Pull Request with a clear description of the changes.

📝 Pull Request Guidelines

  • Include a clear, descriptive title for your PR.
  • Explain the "why" behind your changes.
  • If you're fixing a bug, reference the issue number.
  • Ensure all CI checks (deployment preview, linting) pass before requesting a review.

⚖️ Style Guide

  • Tone: Professional, clear, and educational.
  • Formatting: Use standard Markdown. For films, follow the nested parent-child list format.
  • Images: Place images in static/img/ and reference them using relative paths.

🤝 Community Behavior

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for your contributions!