Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 2.48 KB

Contributing to Swift Type

Welcome to Swift Type! I appreciate your interest in contributing to our project. By contributing, you can help make this project better and more valuable for the community. Whether you're a developer, designer, tester, or just someone with good ideas, I welcome your contributions.

Please take a moment to review this document for important information on how to contribute effectively.

Table of Contents

  1. Getting Started
  2. Code of Conduct
  3. How to Contribute
  4. Pull Request Guidelines
  5. Reporting Issues
  6. License

Getting Started

To get started with contributing, you'll need to:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your work: git checkout -b feature/your-feature-name.

Now, you are ready to start making changes.

Code of Conduct

Be cool and follow the norm. I have a Code of Conduct that I expect all contributors to adhere to. Please read it to understand the expectations for behavior within our community.

How to Contribute

You can contribute to the project in various ways:

  • Writing code (new features, bug fixes, improvements)
  • Improving documentation
  • Reporting and verifying issues
  • Reviewing and commenting on pull requests
  • Providing feedback and suggestions

Pull Request Guidelines

Before submitting a pull request (PR), please ensure the following:

  1. Your code is clean and follows the project's coding style.
  2. You have written unit tests, where applicable, and they pass.
  3. The commit message is descriptive and follows the commit message guidelines.
  4. You have updated the project documentation, if necessary.

Reporting Issues

If you encounter a bug, have a feature request, or have questions about the project, please open an issue in our issue tracker. When reporting issues, please provide as much detail as possible, including:

  • A clear and concise description of the issue or request.
  • Steps to reproduce the issue.
  • Expected behavior vs. actual behavior.
  • Screenshots or error messages, if applicable.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License of this project.

Thank you for your contribution!

-- HauseMaster