Skip to content

Latest commit

 

History

History
68 lines (55 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

68 lines (55 loc) · 2.28 KB

# Contributing to MesBaX

We appreciate your interest in contributing to MesBaX! Whether it's fixing bugs, adding new features, improving documentation, or providing suggestions, your help is valuable.

🛠️ How to Contribute

1️⃣ Report Issues

  • If you encounter any bugs or have feature requests, create a detailed issue in the Issues tab.
  • Include as much information as possible (e.g., steps to reproduce, expected behavior, actual behavior, screenshots).

2️⃣ Submit Pull Requests

  1. Fork the repository:
    • Click on the "Fork" button in the top-right corner of this repository.
  2. Clone your forked repository: 
    git clone https://github.com/phamtiendungcw/MesBaX.git
cd MesBaX
  3. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  4. Make your changes:
    • Follow the project's coding standards.
    • Ensure that the code is well-documented.
  5. Commit your changes: 
    git add .
git commit -m "Add: Description of the changes"
  6. Push your branch to your forked repository: 
    git push origin feature/your-feature-name
  7. Submit a pull request (PR):
    • Navigate to the original repository and click on "New Pull Request."
    • Provide a clear description of your changes and their purpose.

🧪 Code Standards and Guidelines

  • Follow Clean Code Principles: Keep the code simple, readable, and maintainable.
  • Formatting:
    • Use spaces for indentation.
    • Follow the .editorconfig settings (if provided).
  • Testing:
    • Test your code thoroughly before submitting.
    • Add unit tests if you're adding new functionality.
  • Documentation:
    • Update the README.md or any relevant documentation files if your changes affect them.

💬 Community Guidelines

  • Be respectful and inclusive.
  • Constructive feedback is encouraged.
  • When in doubt, ask! Open discussions in Discussions.

📝 License

By contributing to this repository, you agree that your contributions will be licensed under the repository's Apache 2.0 License.

We look forward to collaborating with you! 🚀