Contributing to Swaggular

February 13, 2026 ยท View on GitHub

First off, thank you for considering contributing to this project! It's people like you that make the open-source community such an amazing place to learn, inspire, and create.

How Can I Contribute?

Reporting Bugs

  • Check the GitHub Issues tab to see if the bug has already been reported.
  • If not, create a new issue. Clearly describe the problem, including steps to reproduce it.

Suggesting Enhancements

  • If you have an idea for a new feature, please open an issue to discuss it before starting work.

Pull Requests

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name.
  3. Make your changes.
  4. Ensure your code follows the project's style guidelines (run npm run lint).
  5. Write tests for your changes (not mandatory).
  6. Commit your changes with descriptive commit messages.
  7. Push to your fork and submit a pull request.

Style Guidelines

  • Use Prettier for formatting.
  • Follow the ESLint rules defined in the project.
  • Write clear, descriptive commit messages.

Code of Conduct

Help us keep this project open and inclusive. Please read and follow our Code of Conduct.