Merge pull request Idean#134 from gaelfoppolo/how-to-contribute

add "How to contribute" guide

Author: meltenc

CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at oss@backelite.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).

CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to _SonarQube Plugin for Swift_
+
+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! 👍
+
+## I want to report a problem or ask a question
+
+Before submitting a new GitHub issue, please make sure to
+
+- Check out the [documentation](https://github.com/Backelite/sonar-swift/tree/develop/docs).
+- Check out the README and especially the usage guide.
+- Search for [existing GitHub issues](https://github.com/Backelite/sonar-swift/issues).
+
+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.)
+
+**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.
+
+## I want to contribute to _SonarQube Plugin for Swift_
+
+### Prerequisites
+
+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).
+
+### Checking out the repository
+
+- Make sure you are on the *develop* branch: https://github.com/Backelite/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_.
+
+### Things to keep in mind
+
+- Please do not change the minimum SonarQube version
+- Always document new public methods and properties
+
+### Testing your local changes
+
+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](https://github.com/JakeLin/SwiftLanguageWeather) project should run without issues
+
+### Submitting the PR
+
+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
+
+Some best practices are:
+
+- Use a descriptive title
+- Link the issues that are related to your PR in the body
+
+## Code of Conduct
+
+Help us keep _SonarQube Plugin for Swift_ open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Above All, Thanks for Your Contributions
+
+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!
+
+## License
+
+This project is licensed under the terms of the GNU LGPL v3 license. See the [LICENSE](./LICENSE.md) file for more info.
+
+_These contribution guidelines were adapted from [_fastlane_](https://github.com/fastlane/fastlane) guides._

README.md

@@ -88,9 +88,12 @@ If you still have *run-sonar-swift.sh* file in each of your project (not recomme
 
 ### Contributing
 
-Feel free to contribute to this plugin by issuing pull requests to this repository.
+Thank you for your interest in the project! Contributions are welcome and appreciated.
 
-When creating a pull request: always create it for the *develop* branch. 
+Make sure to read these guides before getting started:
+
+- [Code of Conduct](./CODE_OF_CONDUCT.md)
+- [Contribution Guidelines](./CONTRIBUTING.md)
 
 ### License