|
| 1 | +# Contributing to _SonarQube Plugin for Swift_ |
| 2 | + |
| 3 | +The following is a set of guidelines for contributing to _SonarQube Plugin for Swift_ on GitHub. |
| 4 | + |
| 5 | +> Above all, thank you for your interest in the project and for taking the time to contribute! 👍 |
| 6 | +
|
| 7 | +## I want to report a problem or ask a question |
| 8 | + |
| 9 | +Before submitting a new GitHub issue, please make sure to |
| 10 | + |
| 11 | +- Check out the [documentation](https://github.com/Backelite/sonar-swift/tree/develop/docs). |
| 12 | +- Check out the README and especially the usage guide. |
| 13 | +- Search for [existing GitHub issues](https://github.com/Backelite/sonar-swift/issues). |
| 14 | + |
| 15 | +If the above doesn't help, please [submit an issue](https://github.com/Backelite/sonar-swift/issues) on GitHub and provide information about your setup (SonarQube version, etc.) |
| 16 | + |
| 17 | +**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. |
| 18 | + |
| 19 | +## I want to contribute to _SonarQube Plugin for Swift_ |
| 20 | + |
| 21 | +### Prerequisites |
| 22 | + |
| 23 | +To develop _SonarQube Plugin for Swift_, you will need to meet the prerequisites as specified in the [README](https://github.com/Backelite/sonar-swift#prerequisites). |
| 24 | + |
| 25 | +### Checking out the repository |
| 26 | + |
| 27 | +- Make sure you are on the *develop* branch: https://github.com/Backelite/sonar-swift/tree/develop |
| 28 | +- Click the “Fork” button in the upper right corner of repo |
| 29 | +- Clone your fork: |
| 30 | + - `git clone https://github.com/<YOUR_GITHUB_USERNAME>/sonar-swift.git` |
| 31 | + - Learn more about how to manage your fork: <https://help.github.com/articles/working-with-forks/> |
| 32 | +- Create a new branch to work on: |
| 33 | + - `git checkout -b <YOUR_BRANCH_NAME>` |
| 34 | + - A good name for a branch describes the thing you’ll be working on, e.g. `add-swiftlint-rules`, `fix-swift-lexer`, etc. |
| 35 | + |
| 36 | +That’s it! Now you’re ready to work on _SonarQube Plugin for Swift_. |
| 37 | + |
| 38 | +### Things to keep in mind |
| 39 | + |
| 40 | +- Please do not change the minimum SonarQube version |
| 41 | +- Always document new public methods and properties |
| 42 | + |
| 43 | +### Testing your local changes |
| 44 | + |
| 45 | +Before opening a pull request, please make sure your changes don't break things. |
| 46 | + |
| 47 | +- The project and the plugin should build without warnings |
| 48 | +- The [Swift Language Weather](https://github.com/JakeLin/SwiftLanguageWeather) project should run without issues |
| 49 | + |
| 50 | +### Submitting the PR |
| 51 | + |
| 52 | +When the coding is done and you’ve finished testing your changes, you are ready to submit the PR to the [main repo](https://github.com/Backelite/sonar-swift). Again, make sure you submit your PR to the *develop* branch: https://github.com/Backelite/sonar-swift/tree/develop |
| 53 | + |
| 54 | +Some best practices are: |
| 55 | + |
| 56 | +- Use a descriptive title |
| 57 | +- Link the issues that are related to your PR in the body |
| 58 | + |
| 59 | +## Code of Conduct |
| 60 | + |
| 61 | +Help us keep _SonarQube Plugin for Swift_ open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). |
| 62 | + |
| 63 | +## Above All, Thanks for Your Contributions |
| 64 | + |
| 65 | +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! |
| 66 | + |
| 67 | +## License |
| 68 | + |
| 69 | +This project is licensed under the terms of the GNU LGPL v3 license. See the [LICENSE](./LICENSE.md) file for more info. |
| 70 | + |
| 71 | +_These contribution guidelines were adapted from [_fastlane_](https://github.com/fastlane/fastlane) guides._ |
0 commit comments