Skip to content

Files

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Latest commit

8175fb0 · Nov 1, 2024

History

History
18 lines (12 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

18 lines (12 loc) · 1.06 KB

🌟 Contributing

📜 General Rules

  • 🖋️ Follow the existing format of markdown and code as much as possible.
  • 🔍 Run npm run lint and npm test before submitting your pull request.
  • ✅ Ensure 100% of your code is covered by tests.

🌍 Contributing a New Translation

  • 📄 Create a new README.xx-XX.md file for your translation alongside the main README.md. Use locale and country/region codes for naming (xx-XX), like en-US, zh-CN, ko-KR, etc.
  • 📁 Translate any relevant sub-folders by creating README.xx-XX.md files in each.

📐 Contributing a New Algorithm

  • 🎯 Keep pull requests specific and focused. For example, rather than submitting "several sorting algorithms," submit them individually, such as one PR for "Quick Sort" and another for "Heap Sort."
  • 📝 Include a README.md file for each algorithm with a detailed explanation and links to additional resources.
  • 💬 Use comments in your code to describe each step and clarify your logic.