static-web-server/CONTRIBUTING.md

Contributing to The Static Web Server project

Looking to contribute? You’re welcome!

Code of Conduct

First, all project interactions must follow the code of conduct to ensure everyone is treated with respect.

Issues

• Filing an issue is a valuable contribution. Reporting bugs and providing details helps us improve SWS and stay informed about issues we might not have noticed otherwise.
• Security issues has some consideration to take into your account first.

Pull Requests

Consider checking the list of issues if you want to submit something.

• Submitting a Pull Request
• Commit Guidelines

Documentation

Improving SWS documentation greatly helps everyone trying to use it.

• The main website documentation is hosted in the repository and can be improved by following the documentation instructions.
• The API documentation (rendered at docs.rs/static-web-server) is stored as rustdoc comments directly in the source.

Help

Helping others integrate SWS into their workflows is a valuable way to contribute:

• Answer questions in SWS's Discussions or on our Discord.
• Write blog posts about using SWS, contributing features, or debugging issues. Your posts add unique insights and examples that may not fit in the SWS repo, helping more users find solutions and explore new use cases.