Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 2.07 KB
Raw

Contribution Guidelines

Thank you for considering contributing to EventWise! We welcome your contributions to enhance the system and make it even better. To ensure a smooth and collaborative development process, please follow these guidelines:

Getting Started

  1. Fork the repository and clone it to your local machine.
  2. Install the necessary dependencies by running pip install -r requirements.txt.
  3. Create a new branch for your contribution: git checkout -b feature/new-feature or bugfix/issue-fix.
  4. Make your changes, ensuring they align with the project's coding style and guidelines.
  5. Test your changes thoroughly to ensure they work as intended.

Submitting a Pull Request

  1. Once you're satisfied with your changes, push your branch to your forked repository.
  2. Submit a pull request (PR) to the main branch of the main repository.
  3. Provide a clear and descriptive title for your PR.
  4. Include a detailed description of the changes you've made and their purpose.
  5. Ensure your code is well-documented and include relevant tests if applicable.
  6. Be responsive to feedback and address any review comments or requests for changes promptly.

Code Style and Guidelines

  • Follow the existing code style and conventions used in the project.
  • Write clear and concise code with meaningful variable and function names.
  • Include comments where necessary to explain complex logic or improve code readability.
  • Use proper indentation and formatting to ensure code consistency.

Reporting Issues

If you encounter any bugs, issues, or have feature requests, please submit them via the GitHub issue tracker. Provide detailed information about the problem, including steps to reproduce it, if applicable.

License

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

Contact

If you have any questions or need further assistance, feel free to reach out to the project maintainers at [email protected].

We appreciate your contributions and look forward to working together to improve EventWise!