The following is a set of guidelines for contributing to SonarQube Plugin for Swift on GitHub.
Above all, thank you for your interest in the project and for taking the time to contribute! 👍
Before submitting a new GitHub issue, please make sure to
- Check out the documentation.
- Check out the README and especially the usage guide.
- Search for existing GitHub issues.
If the above doesn't help, please submit an issue on GitHub and provide information about your setup (SonarQube version, etc.)
Note: If you want to report a regression in SonarQube Plugin for Swift (something that has worked before, but broke with a new release), please mark your issue title as such using [Regression] Your title here. This enables us to quickly detect and fix regressions.
To develop SonarQube Plugin for Swift, you will need to meet the prerequisites as specified in the README.
- Make sure you are on the develop branch: https://github.com/tal-tech/sonar-swift/tree/develop
- Click the “Fork” button in the upper right corner of repo
- Clone your fork:
git clone https://github.com/<YOUR_GITHUB_USERNAME>/sonar-swift.git- Learn more about how to manage your fork: https://help.github.com/articles/working-with-forks/
- Create a new branch to work on:
git checkout -b <YOUR_BRANCH_NAME>- A good name for a branch describes the thing you’ll be working on, e.g.
add-swiftlint-rules,fix-swift-lexer, etc.
That’s it! Now you’re ready to work on SonarQube Plugin for Swift.
- Please do not change the minimum SonarQube version
- Always document new public methods and properties
Before opening a pull request, please make sure your changes don't break things.
- The project and the plugin should build without warnings
- The Swift Language Weather project should run without issues
When the coding is done and you’ve finished testing your changes, you are ready to submit the PR to the main repo. Again, make sure you submit your PR to the develop branch: https://github.com/tal-tech/sonar-swift/tree/develop
Some best practices are:
- Use a descriptive title
- Link the issues that are related to your PR in the body
Help us keep SonarQube Plugin for Swift open and inclusive. Please read and follow our Code of Conduct.
Thank you for reading to the end, and for taking the time to contribute to the project! If you include the 🔑 emoji at the top of the body of your issue or pull request, we'll know that you've given this your full attention and are doing your best to help!
This project is licensed under the terms of the GNU LGPL v3 license. See the LICENSE file for more info.
These contribution guidelines were adapted from fastlane guides.