Contribution

Lumbermill welcomes bug reports, feature requests, and pull requests.

Reporting Bugs

Report bugs on the GitHub Issues page. Include:

• A clear, descriptive title
• A detailed description of the issue
• Steps to reproduce
• Any relevant logs or screenshots

Requesting Features

Open a new issue on the GitHub Issues page with:

• The problem the feature would solve
• How you envision it working
• Any alternatives you have considered

Contributing Code

1. Fork the repository on GitHub.

2. Clone your fork:

   git clone https://github.com/instance-studio/lumbermill.git

3. Create a branch:

   git checkout -b bugfix/name
   # or
   git checkout -b feature/name

   Working on an open issue?

   Use the issue number as the branch name instead of a descriptive slug.

   git checkout -b bugfix/12
   git checkout -b feature/16

4. Make your changes, following the project’s coding standards.

5. Commit with a clear message:

   git commit -m "Description of the changes"

6. Push to your fork:

   git push origin bugfix/name

7. Open a pull request from your branch to main. Reference any related issues in the description.

Code Review

Submitted pull requests are reviewed by the project maintainers. Respond to feedback and push any requested changes to the same branch. Once approved, the pull request will be merged into main.