Skip to content

Contribution Guide

Everyone can contribute to help other developers utilize this documentation for their learning and to improve their programming skills.

Naming Convention for filenames

  1. Lowercase Letters: Use lowercase letters to maintain consistency and avoid issues in case-sensitive file systems.
  2. Example: frontend-engineering.md

  3. Hyphens for Spaces: Use hyphens to separate words instead of spaces or underscores. This improves readability and avoids issues with URLs.

  4. Example: learning-and-development.md

  5. Descriptive Names: Use descriptive names that clearly indicate the content of the file.

  6. Example: introduction-to-css.md

  7. Avoid Special Characters: Avoid using special characters except for hyphens. This prevents potential issues with different operating systems.

  8. Example: setup-guide.md

  9. Versioning: If versioning is necessary, include the version number at the end of the file name.

  10. Example: api-documentation-v1.0.md

  11. Dates: If including dates, use the ISO format (YYYY-MM-DD) for clarity and sorting purposes.

  12. Example: release-notes-2024-07-06.md

Following these guidelines, some examples of Markdown file names are:

  • getting-started.md
  • frontend-best-practices.md
  • responsive-design.md
  • javascript-fundamentals.md
  • css-tips-and-tricks.md

Home