Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 3.26 KB
Raw

Contributing to CSV Viewer

Thank you for considering contributing to CSV Viewer! I appreciate your interest in participating in the project :D

Please take a moment to review the following guidelines before submitting your contribution. These guidelines will help ensure that your contributions are effective and can be smoothly integrated into the project.

Table of Contents

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code of conduct. Please report any unacceptable behavior to the project maintainers.

How to Contribute

You can contribute in a variety of ways, including reporting bugs, requesting features, and submitting pull requests. Please take a moment to review the Coding Guidelines before submitting a pull request.

Reporting Bugs

If you encounter any bugs or issues while using CSV Viewer, please help us by reporting them. To report a bug, follow these steps:

  1. Check the existing GitHub issues to ensure the bug hasn't already been reported.
  2. If the bug is not yet reported, open a new issue and provide a clear and descriptive title.
  3. Describe the steps to reproduce the bug and provide any relevant information.
  4. Include screenshots or error messages, if applicable.
  5. Label the issue with appropriate tags (e.g., "bug", "help wanted").

Requesting Features

If you have a feature request for CSV Viewer, I encourage you to submit it as an issue on GitHub. Follow these steps to request a feature:

  1. Search the existing GitHub issues to ensure the feature hasn't already been requested.
  2. If the feature is not yet requested, open a new issue and provide a concise and descriptive title.
  3. Clearly explain the feature you would like to see implemented and why it would be beneficial.
  4. Label the issue with appropriate tags (e.g., "enhancement", "feature request").

Submitting Pull Requests

Pull requests are welcomed. If you have an improvement or bug fix to contribute, please follow these steps:

  1. Fork the repository and create a new branch from the main branch.
  2. Ensure your code follows the project's coding guidelines (see Coding Guidelines).
  3. Provide clear and concise commit messages for each commit.
  4. Test your changes thoroughly to ensure they don't introduce new issues.
  5. Submit a pull request to the main branch of the CSV Viewer repository.
  6. Ensure that your pull request includes a detailed description of the changes you made.

Coding Guidelines

To maintain consistency and readability, please adhere to the following coding guidelines when contributing:

  • Follow the coding style already established in the project.
  • Write clear and concise code with appropriate comments where necessary.
  • Ensure your code is well-tested and free of linting errors.

License

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