Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.09 KB

Contributing to http-status-toolkit

Thanks for taking the time to contribute! 🎉

How to Contribute

  • 💡 Found a bug? Please open an issue.
  • 📝 Want to suggest a new HTTP status code/message or fix a typo? Pull requests are welcome!
  • 📚 Found a documentation improvement? Feel free to edit README.md or related docs.

Getting Started

  1. Fork the repository
  2. Clone your fork:
    git clone https://github.com/dev-rashedin/http-status-toolkit.git
  3. Install dependencies:
    npm install
  4. Run the dev environment:
    npm run dev
  5. Run tests before pushing:
    npm test

Coding Guidelines

  • Use TypeScript
  • Follow the existing code style
  • Run npm run check before pushing (it builds + tests)

Commit Messages

Please use Conventional Commits format, such as:

feat: add support for 425 Too Early fix: correct typo in status message docs: improve README example

Code of Conduct

By contributing, you agree to follow our Code of Conduct.