Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 2.37 KB

contributing.md

File metadata and controls

55 lines (34 loc) · 2.37 KB
Raw

Contributing Guidelines

Thank you for considering contributing! We welcome contributions from everyone, whether it's through code, bug reports, feature suggestions, or documentation improvements.

To ensure a smooth contribution process, please follow these guidelines.

Ways to Contribute

1. Code Contributions

If you'd like to contribute code to the project, please follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your feature or bug fix: git checkout -b feature-name.
  3. Write your code and ensure it adheres to our coding standards.
  4. Test your changes locally to ensure they work as expected.
  5. Commit your changes with descriptive commit messages: git commit -am 'Add new feature: feature-name'.
  6. Push your branch to your fork: git push origin feature-name.
  7. Open a pull request against the main branch of our repository.

2. Bug Reports

If you encounter a bug while using our website, please help us fix it by submitting a detailed bug report. Include information such as:

  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Screenshots or error messages, if applicable

3. Feature Requests

If you have an idea for a new feature or improvement, feel free to open an issue on GitHub to discuss it. Provide as much detail as possible about the feature and why you think it would be valuable.

4. Documentation

Improving documentation is always appreciated! If you notice any errors or areas where documentation could be clarified, please submit a pull request with your changes.

Code Style and Standards

When contributing code, please adhere to the following guidelines:

  • Follow the coding style and conventions used throughout the project.
  • Write clear, concise, and descriptive commit messages.
  • Ensure your code is well-documented, especially for complex or non-obvious functionality.
  • Test your changes thoroughly to ensure they don't introduce regressions.

Code of Conduct

Please note that we have a Code of Conduct in place to ensure a welcoming and inclusive environment for all contributors. By participating in this project, you agree to abide by its terms.

Questions and Support

If you have any questions or need support while contributing, don't hesitate to reach out to us through GitHub issues or our community forums.

Thank you for your interest in contributing!