Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (44 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 2.5 KB
Raw

Contributing Guidelines

Thank you for considering contributing to ValidationEngine! We welcome contributions from everyone. By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub repository. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Enhancements

We welcome suggestions for new features or improvements. Please open an issue to discuss your ideas. Be sure to provide as much detail as possible and explain the benefits of your suggestion.

Commit Message Format:

  • [optional scope]:
  • [optional body]
  • [optional BREAKING CHANGE: description]

Submitting Pull Requests

  1. Fork the Repository: Click the "Fork" button at the top of the repository page to create a copy of the repository in your GitHub account.
  2. Clone Your Fork: Clone your forked repository to your local machine. 
    git clone https://github.com/shanewas/ValidationEngine.git
  3. Create a Branch: Create a new branch for your changes. 
    git checkout -b feature/your-feature-name
  4. Make Changes: Make your changes in the new branch.
  5. Commit Changes: Commit your changes with a descriptive commit message. 
    git commit -m "Add feature: your feature description"
  6. Push Changes: Push your changes to your forked repository. 
    git push origin feature/your-feature-name
  7. Open a Pull Request: Go to the original repository and open a pull request. Provide a clear description of your changes and any related issue numbers.

Code Style

Please follow the coding style used in the project. Consistent code style helps maintain readability and ease of maintenance.

Documentation

If you add or modify functionality, please update the documentation accordingly. This helps other contributors understand your changes and how to use the new features.

Testing

Ensure that your changes do not break existing tests and add new tests for any new functionality. This helps maintain the stability and reliability of the project.

Getting Help

If you need help or have questions, feel free to open an issue or reach out to the community through our support channels.

Support

  • GitHub Issues
  • Documentation

Code of Conduct

Please note that this project is governed by our Code of Conduct. By participating, you are expected to uphold this code.