Contributing to Sidey

Sidey is an open source project and contributions are welcome. Whether you found a bug, have a feature request, or want to improve the codebase, here is how to get involved.

Reporting bugs

If something is not working as expected, open an issue on the Sidey GitHub repository.

A good bug report includes:

• A clear description of the problem
• Steps to reproduce it
• What you expected to happen versus what actually happened
• Your Node.js version and any relevant environment details

Requesting features

Feature requests are also welcome. Open an issue and describe what you would like to see and why it would be useful. The more context you provide, the easier it is to evaluate and prioritize.

Submitting a pull request

If you would like to contribute code, follow these steps:

1. Fork the repository and clone it locally
2. Create a new branch from main with a descriptive name (fix/lightbox-close, feat/dark-mode-toggle)
3. Make your changes and test them locally with npm run dev
4. Commit your changes with a clear message (fix: close lightbox on escape key)
5. Push your branch and open a pull request against main

Please keep pull requests focused. One change per PR makes it easier to review and merge.

Code style

Sidey does not enforce a strict code style beyond what is already in the project. Just try to keep your changes consistent with the surrounding code.

Not sure where to start? Feel free to open an issue and ask. All contributions, big or small, are appreciated.