Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 2.06 KB

Contributing to ExAM

🎉 First off, thank you for considering contributing to ExAM! 🎉

The following is a set of guidelines for contributing to ExAM. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

Before submitting a bug report, please check the issue tracker to see if the issue has already been reported. If it hasn't, open a new issue and provide the following information:

  • Description of the issue: A clear and concise description of what the bug is.
  • Steps to reproduce: Provide steps to reproduce the behavior.
  • Expected behavior: A clear and concise description of what you expected to happen.
  • Screenshots: If applicable, add screenshots to help explain your problem.
  • Environment details: Include details about your environment (e.g., operating system, Python version).

Suggesting Enhancements

If you have ideas for enhancements or new features, you can also submit a new issue detailing your proposal. Provide as much detail and context as possible.

Pull Requests

We welcome pull requests from everyone. To contribute code changes:

  1. Fork the repository and create your branch from main.
  2. Make sure your code follows the project's coding conventions and style.
  3. Make sure that you follow git conventional commits.
  4. Test your changes thoroughly.
  5. Update the documentation if necessary.
  6. Submit your pull request and provide a clear description of the problem and solution.

Code of Conduct

This project and everyone participating in it are governed by the ExAM Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]].

License

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