Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 2.23 KB
Raw

Contributing

I gladly welcome contributions to EasyCsv! If you find a bug or have a feature request, please open an issue on the project's GitHub repository. If you would like to contribute code, please submit a pull request.

In your PR, make note of the following.

  • Code style: Please follow the existing code style and conventions used throughout the project. This ensures consistency and makes it easier for others to understand the codebase.

  • Testing: Ensure that your code is well-tested. Add new tests if necessary and make sure all existing tests pass. This will help maintain the stability and reliability of the project.

  • Documentation: Update any relevant documentation, including inline comments, README files, or API documentation, to accurately reflect the changes you've made. This will help other contributors and users understand the changes and their impact.

  • Commit messages: Write clear, concise, and descriptive commit messages that briefly explain the changes made in each commit. This will help maintain a clear and easily navigable commit history.

Setting up your development environment

Before submitting a PR, please make sure you have a proper development environment set up:

  1. Fork the EasyCsv repository on GitHub and clone your fork to your local machine.
  2. Build the solution and run the tests to ensure that everything is working correctly.
  3. Create a new branch for your changes. Use a descriptive name that reflects the purpose of your changes.

Pull request process

When you are ready to submit your changes, follow these steps:

  1. Push your changes to your fork on GitHub.
  2. Open a new pull request against the main branch of the original EasyCsv repository.
  3. In the PR description, provide a clear and detailed explanation of the changes you've made and why they are necessary. Include any relevant issue numbers.
  4. Be prepared to address any feedback or requested changes from the project maintainers. This may involve additional commits or changes to your existing commits.
  5. Once your PR has been reviewed and approved, it will be merged into the main branch. Your contributions will be greatly appreciated and will help improve EasyCsv for everyone.

Thank you for considering contributing to EasyCsv!