Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 1.87 KB

Contributing Guidelines

Thank you for considering contributing to RocketDocs! By participating in this project, you contribute to making API documentation exploration easier for everyone.

How Can I Contribute?

Reporting Bugs

  • Before reporting a bug, ensure that it hasn't already been reported by checking the existing issues.
  • If you find a bug that hasn't been reported, open a new issue. Provide a clear and descriptive title along with detailed steps to reproduce the bug.

Suggesting Enhancements

  • Feel free to suggest enhancements or new features by opening an issue. Clearly describe your idea and provide any relevant context or examples.
  • Discuss your ideas with other contributors and maintainers to gather feedback and refine your proposal.

Contributing Code

  • Fork the repository and create a new branch for your contribution.
  • Ensure that your code follows the project's coding conventions and style guidelines.
  • Write clear and concise commit messages.
  • Make sure to test your changes thoroughly.
  • Once ready, submit a pull request (PR) to the main repository.
  • Your PR will be reviewed by the maintainers, and feedback may be provided to address any necessary changes.

Code of Conduct

  • Please adhere to the project's Code of Conduct in all interactions, whether on the repository's issue tracker, pull requests, or elsewhere.

License

  • By contributing to RocketDocs, you agree that your contributions will be licensed under the project's MIT License.

Need Help?

  • If you need assistance or have any questions, feel free to reach out by opening an issue or contacting us via email at [email protected].

Thank you for your interest in contributing to RocketDocs! Your contributions are highly valued and appreciated.