Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 2.31 KB

contributing.md

File metadata and controls

44 lines (27 loc) · 2.31 KB
Raw

Contributing to Smart Schema Builder

Thank you for considering contributing to Smart Schema Builder! We welcome contributions from the community, whether it's bug reports, feature requests, code improvements, or documentation enhancements. By contributing, you can help make Smart Schema Builder even better.

To get started, please take a moment to review the guidelines below.

How to Contribute

  1. Fork the repository on GitHub.
  2. Create a new branch from the main branch for your changes.
  3. Make your desired changes to the codebase.
  4. Ensure that your changes follow the project's coding conventions and guidelines.
  5. Write appropriate tests for your changes, ensuring that the existing tests still pass.
  6. Commit your changes and push your branch to your forked repository.
  7. Submit a pull request to the main branch of the Smart Schema Builder repository.

Reporting Issues

If you encounter any issues with Smart Schema Builder, please report them using the GitHub issue tracker. When reporting an issue, please provide as much information as possible, including a clear description of the problem, steps to reproduce it, and any relevant error messages or logs.

Feature Requests

If you have a feature request or an idea for enhancing Smart Schema Builder, please open a new issue on GitHub. Clearly describe the requested feature and the problem it solves. Any additional context or examples are highly appreciated.

Code Contribution Guidelines

When contributing code to Smart Schema Builder, please adhere to the following guidelines:

  • Follow the existing code style and conventions used throughout the project.
  • Ensure that your code changes are well-documented, with clear comments where necessary.
  • Write appropriate unit tests for your code changes to maintain the test coverage.
  • Run the existing test suite to ensure that your changes do not introduce any regressions.

Documentation

Improvements to the documentation are always welcome. If you find any areas that can be clarified or expanded, feel free to submit a pull request with the necessary changes.

License

By contributing to Smart Schema Builder, you agree that your contributions will be licensed under the MIT License.

Thank you for your interest in contributing to Smart Schema Builder. Your efforts are greatly appreciated!