Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (38 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

62 lines (38 loc) · 1.78 KB

🤝 Contributing to Hangman Bot

Thank you for your interest in contributing to Hangman Bot! We welcome all kinds of contributions — from bug fixes and new features to doc improvements and suggestions.

📋 Guidelines

1. Fork & Clone

2. Branching

  • Create a new branch for your work:

    git checkout -b feature/your-feature-name

  • Use descriptive branch names (e.g., fix/word-bank-bug, feature/multiplayer-mode).

3. Code Style

  • Follow standard JavaScript/Node.js conventions.
  • Keep code modular and clean.
  • Use meaningful commit messages: git commit -m "feat: add multiplayer challenge command"

4. Testing

  • Test your changes locally before submitting.
  • Ensure the bot runs without errors

5. Pull Requests

  • Push your branch to your fork:

    git push origin feature/your-feature-name

  • Open a Pull Request (PR) against the main branch of the original repo.

  • Clearly describe your changes in the PR description.

🛠️ Areas to Contribute

  • Bug Fixes: Squash issues and improve stability.
  • Features: Add new commands, game modes, or enhancements.
  • Documentation: Improve README, add examples, or clarify instructions.
  • Testing: Write unit tests or improve coverage.

📜 Code of Conduct

Please be respectful and collaborative. We aim to maintain a welcoming environment for developers of all levels.

💡 Tips

  • If unsure about a change, open an issue first to discuss.
  • Small, focused PRs are easier to review and merge.
  • Keep dependencies minimal and secure.

📜 License

By contributing, you agree that your contributions will be licensed under the MIT License.