We welcome contributions to [Project Name]! Whether it's a bug report, new feature, or documentation improvement, your help is greatly appreciated. Please take a moment to read through the guidelines below to make sure your contribution is effective.
If you've found a bug, please help us by opening a new issue. When filing a bug report, include:
- A clear and descriptive title.
- The version of the project and Swift you're using.
- Steps to reproduce the issue.
- A detailed description of the problem.
- Any relevant code snippets or screenshots.
We encourage you to suggest new features or enhancements. When submitting feature requests:
- Explain your idea and why it would be useful.
- Provide any potential use cases or examples.
If you are able to implement the feature, feel free to open a pull request after discussing it with the maintainers.
We encourage pull requests! To help us efficiently review your pull request, please follow these steps:
- Fork the repository and clone it locally:
git clone https://github.com/your-username/project-name.git
- **Create a new branch for your changes:
git checkout -b feature-or-bugfix-name
- Make your changes, and ensure your code is well-formatted and documented.
- Test your changes to make sure everything works as expected: • If you are adding new functionality, write unit tests to cover the new code. • Make sure all existing tests pass by running:
- Commit and push your changes with a clear commit message:
git commit -m "Add feature/fix bug: short description"