Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (63 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

104 lines (63 loc) · 2.69 KB

Contributing to HxReact

👋 Welcome, and thank you for your interest in contributing to HxReact! Whether you're fixing bugs, improving documentation, or building new features, your help is valuable. This guide outlines the contribution process.

🛠️ Getting Started

1. Fork the Repository

  1. Navigate to the HxReact repository: HxReact
  2. Click the Fork button in the upper right corner to create your copy of the repo.

2. Clone Your Fork

Clone your fork to your local machine to start working:

git clone https://github.com/YOUR_USERNAME/hxreact.git
cd hxreact

3. Set Up the Project

Before making changes, install dependencies and set up the project locally:

npm install

4. Create a Branch

Always work in a new branch:

git checkout -b feature/your-branch-name

For example, if you're fixing a bug, you could use:

git checkout -b fix/bug-description

📝 Making Changes

  • Code Style: Please follow consistent coding practices. Run npm run lint before submitting to ensure your code follows the project style.

  • Documentation: Update or add documentation if you're introducing new features or modifying existing ones.

  • Commits: Make sure to write clear and descriptive commit messages. For example:

    • fix: resolve issue with X
    • feat: add support for Y
    • docs: update contributing guidelines

🚀 Testing

Be sure your changes don't break anything by running tests:

npm run test

For new features or significant changes, please write or update the existing tests.

📥 Submitting a Pull Request (PR)

  1. Push your changes to your fork:

    git push origin feature/your-branch-name

  2. Open a pull request (PR) on the HxReact repository:

    • Go to Pull Requests in your fork.
    • Click New Pull Request.
    • Choose your branch, provide a clear description of what you’ve done, and submit your PR.

  3. Link any related issues in your PR description, e.g. Fixes #123.

🛡️ Code of Conduct

By participating in this project, you agree to uphold our Code of Conduct. Respectful and constructive behavior is expected at all times.

💬 Need Help?

If you need help at any point in the process, feel free to open an issue or contact @HxHippy on X.

Thank you for your contributions and making HxReact even better! 🚀

📄 License

By contributing to HxReact, you agree that your contributions will be licensed under the Apache 2.0 License.