Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

50 lines (32 loc) · 1.65 KB

Contributing to File Name Checker

First off, thanks for taking the time to contribute! 🎉 You're awesome! 🤩

How Can I Contribute?

Reporting Bugs

If you find a bug, please create an issue in the Issues section of the repository with the following details:

  • A clear description of the problem
  • Steps to reproduce the problem
  • Expected behavior
  • Screenshots or logs, if applicable

Suggesting Features

We’re always open to new ideas! If you have a feature suggestion, please create an issue and label it as a feature request. Include:

  • A detailed explanation of the feature
  • Why you think it would be useful
  • Any potential downsides or challenges

Pull Requests

Pull requests are welcome! Please make sure your changes adhere to the following guidelines:

  • Fork the repository and clone it locally.
  • Create a branch for your contribution: git checkout -b your-branch-name.
  • Commit your changes: git commit -m 'Add some feature'.
  • Push to the branch: git push origin your-branch-name.
  • Open a pull request and describe what your PR does and why it's needed.

Code Style

  • Follow the code style used in the repository (e.g., indentation, naming conventions).
  • Keep your code clean and well-commented.
  • Write meaningful commit messages.

Testing

Please ensure that your changes don’t break existing functionality.

Documentation

Update docs to reflect your changes, including comments in code and any relevant markdown files.

Community

Be respectful and considerate in your interactions with others. We value a positive and constructive community.

Thank you 😁