Contribution Guidelines
Thank you for considering contributing to the Matchy project! We welcome contributions from everyone, whether it's reporting bugs, fixing issues, or adding new features. Your contributions help improve the library for everyone.
Ways to Contribute There are several ways to contribute:
Report Bugs: If you encounter any bugs or unexpected behavior, please open an issue on our issue tracker. Fix Issues: You can browse through the open issues on our issue tracker and pick any issue you'd like to work on. If you fix an issue, please submit a pull request. Add Features: Have an idea for a new feature? Feel free to implement it and submit a pull request. Improve Documentation: Documentation is crucial for a successful project. If you find any gaps or errors in the documentation, please help improve it. Review Pull Requests: Reviewing pull requests is a valuable way to contribute. Your feedback can help ensure the quality and correctness of contributions. Spread the Word: If you find the Matchy library useful, consider spreading the word about it. Share it with your friends, colleagues, or on social media.
Getting Started If you're new to contributing to open-source projects or to Git and GitHub, don't worry! Here's how you can get started:
Fork the Repository: Click the "Fork" button on the top right corner of the repository's page to create your copy of the project. Clone the Repository: Clone the repository to your local machine using Git:
git clone https://github.com/RaoufGhrissi/matchy
Create a Branch: Create a new branch for your work. Choose a descriptive name that summarizes the purpose of your changes:
git checkout -b feature/add-new-validation
Make Changes: Make your changes to the codebase. Ensure that your changes adhere to the coding standards and conventions used in the project.
Do your changes in src folder in ts files then run
tsc
to generate an updated dist folder with your new changes.
Test Your Changes: Test your changes thoroughly to ensure that they work as expected and do not introduce any regressions. Commit Your Changes: Once you're satisfied with your changes, commit them to your branch:
git add .
git commit -m "Add new validation feature"
Push Your Changes: Push your changes to your forked repository on GitHub:
git push origin feature/add-new-validation
Submit a Pull Request: Go to the GitHub page of your forked repository, select your branch, and click the "Pull Request" button to submit your changes for review. Code Style and Guidelines Please follow the existing code style and guidelines used in the project. This helps maintain consistency and readability across the codebase.
Code of Conduct We expect all contributors to adhere to the project's Code of Conduct. Please be respectful and considerate towards others.
Feedback If you have any feedback or suggestions on how we can improve the contribution process, please let us know. We're always looking for ways to make it easier for people to contribute to the project.
Thank you for contributing to the CSV Validator project! 🎉