Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (40 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 2.15 KB

🤝 Contributing to Lax

First off, thank you for considering contributing to Lax! We highly value the open-source community and believe that every contribution—whether it's fixing a typo, fixing a bug, or adding a new feature—makes this project stronger.

We welcome contributions from everyone, regardless of experience level.

🚀 How to Contribute

To ensure a smooth workflow, please follow these steps:

1. Fork the Project

Go to the top-right corner of the repository page and click Fork. This creates a copy of the Lax repository in your own GitHub account.

2. Clone and Create a Branch

Clone your fork to your local machine and create a new branch for your changes. Please use a descriptive name for your branch.

# Clone your fork
git clone [https://github.com/lax-inc/Lax.git](https://github.com/lax-inc/Lax.git)

# Create a new branch
git checkout -b feature/my-new-feature
# or for bug fixes
git checkout -b fix/bug-description

3. Make Changes and Test

Write your code!

  • Important: Please ensure you test your changes locally. We want to keep Lax stable and lightweight.
  • If you added a new feature, try to include a simple test case or example to prove it works.

4. Commit and Push

Once you are happy with your changes, commit them and push them to your fork.

git add .
git commit -m "Description of what I changed"
git push origin feature/my-new-feature

5. Submit a Pull Request (PR)

  1. Go to the original Lax repository.
  2. Click on Pull Requests and then New Pull Request.
  3. Select your fork and branch.
  4. Describe your changes: Explain what you changed and why. If it fixes a specific issue, please link to it.

🔍 The Review Process

Once you submit your PR:

  1. Review: Our team will review your code to ensure it meets our quality standards and fits the project's philosophy ("Simplicity is Power").
  2. Feedback: We might ask for small changes or clarifications. This is a normal part of the process!
  3. Merge: If everything looks good and the tests pass, we will merge your contribution into the main branch.

Thank you for helping us build the future of Lax!