Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.67 KB

Contributing to MewNotch

Thank you for your interest in contributing to MewNotch! Your contributions help improve the project and make the Mac notch more useful for everyone. Please follow the guidelines below to ensure a smooth collaboration.

Getting Started

  1. Fork the Repository – Click the Fork button on GitHub and clone your fork locally.
  2. Create a Branch – Use a descriptive name (e.g., feature-animation, bugfix-ui).
  3. Make Your Changes – Follow the coding standards and test your changes.
  4. Commit Your Changes – Use clear and concise commit messages. Use commit description for clarity.
  5. Push and Submit a PR – Push your branch and open a pull request (PR) for review.

Code Guidelines

  • Use Swift and SwiftUI best practices.
  • Follow Apple's Human Interface Guidelines for macOS applications.
  • Keep the code clean and well-documented.
  • Ensure your changes do not introduce new warnings or errors.

Issue Reporting

  • Before submitting a new issue, check for existing issues.
  • Clearly describe the problem and provide reproduction steps.
  • Include screenshots or logs when relevant.

Pull Request Guidelines

  • Keep PRs focused on a single feature or bug fix.
  • Ensure your branch is up to date with main before submitting.
  • Add a descriptive title and detailed explanation.
  • Reference any related issues in your PR description.

Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for all contributors.

License

By contributing, you agree that your contributions will be licensed under the project's GPLv3 License.

Thank you for contributing to MewNotch!