Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 2.38 KB
Raw

Contributing to Selenium Manager

Thank you for considering contributing to the Selenium Manager project! We welcome contributions from the community to help improve and enhance this library. Below are some guidelines to follow when contributing.

Code of Conduct

Please review and adhere to our Code of Conduct to ensure a respectful and inclusive environment for all contributors.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your contribution: git checkout -b feature/your-feature-name.
  4. Make your changes and ensure that the code passes all tests.
  5. Commit your changes: git commit -m "Add your commit message here".
  6. Push your changes to your fork: git push origin feature/your-feature-name.
  7. Create a pull request (PR) from your forked repository to the main repository's main branch.
  8. Provide a clear and concise description of your changes in the PR description.
  9. Ensure that the PR title follows the format: [Feature/Fix] Brief description of your change.

Coding Guidelines

  • Follow the existing coding style and conventions used in the project.
  • Write clear and concise code with appropriate comments and documentation.
  • Keep functions and methods modular and well-organized.
  • Ensure that your code passes all tests before submitting a pull request.
  • Write unit tests for new features or changes whenever possible.

Testing

Before submitting a pull request, make sure to test your changes thoroughly. This includes:

  • Running existing unit tests using the test runner.
  • Adding new unit tests for your changes if applicable.
  • Manual testing of the application to ensure functionality and compatibility.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please open a GitHub issue with a detailed description of the problem and steps to reproduce it.

Pull Request Reviews

Pull requests will be reviewed by project maintainers and contributors. Feedback and suggestions may be provided to ensure the quality and consistency of the codebase.

License

By contributing to this project, you agree to license your contributions under the project's license.

We appreciate your time and effort in contributing to Selenium Manager! Your contributions help make this project better for everyone.