Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.78 KB
Raw

Contributing to FaviconFinder

Thank you for your interest in contributing to FaviconFinder! We appreciate your help in making this project better.

How to Contribute

Reporting Issues

If you've found a bug or an issue, please submit it here. When submitting an issue, include the following:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected vs. actual results.
  • Any relevant logs, screenshots, or environment details.

Suggesting Features

We welcome feature requests! When suggesting a feature, include:

  • A detailed description of the feature.
  • Why it would be useful.
  • Any potential drawbacks.

Pull Requests

To submit a pull request (PR), please follow these steps:

  1. Fork the repo and create your branch: 
    git checkout -b feature/my-new-feature
  2. Ensure your code passes all tests and doesn't raise any SwiftLint warnings.
  3. Submit your PR, and link to any relevant issues or discussions.

Coding Guidelines

  • Code Style: Please follow Swift best practices and use meaningful names for variables and functions.
  • Tests: Ensure that your code is covered by unit tests and that they all pass before submitting.
  • Documentation: Update or create documentation for any new features or changes.

License

By contributing to FaviconFinder, you agree that your contributions will be licensed under the MIT license.

Code of Conduct

The Code of Conduct governs how we behave in public or in private whenever the project will be judged by our actions. We expect it to be honored by everyone who contributes to this project.

See CONDUCT.md for details.