Contributing to Luma
We love contributions! Whether you’re fixing bugs, improving documentation, or adding new features—every contribution makes Luma better for everyone.
Ways to Contribute
There are many ways to help out:
- Report bugs — Found something broken? Open an issue
- Suggest features — Have an idea? We’d love to hear it
- Improve docs — Spotted a typo or unclear explanation? Fix it
- Submit code — Bug fixes and features are always welcome
Getting Started
First, fork and clone the repository:
git clone https://github.com/AlexsandroSA/luma-jekyll.git
cd luma-jekyll
Install dependencies and run the development server:
bundle install
bundle exec jekyll serve
Making Changes
- Create a branch for your changes:
git checkout -b feature/your-feature-name
-
Make your changes and test thoroughly
-
Commit with a clear message:
git commit -m "Add: brief description of your change"
- Push and open a Pull Request
Code Style
Keep these guidelines in mind:
- Use 2 spaces for indentation in SCSS and HTML
- Follow existing naming conventions
- Comment complex logic
- Test on multiple browsers when possible
Pull Request Guidelines
- Keep PRs focused on a single change
- Update documentation if needed
- Add a clear description of what your PR does
- Reference any related issues
Questions?
- Open a GitHub Issue for bugs or features
- Check existing issues before creating new ones
Thank you for helping make Luma better! 🙌