Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release of version 2.1.0 #47

Merged
merged 23 commits into from
May 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
cb5d09a
Fix #33: Add community information
begarco Apr 23, 2020
ebb094c
#33 Add DockerHub badge
begarco Apr 23, 2020
4e731fe
Update versions in latest Docker CAT image
begarco Apr 23, 2020
42b40da
Update Cppcheck and Vera++ version in readme
begarco Apr 23, 2020
823952c
Update tools versions
begarco Apr 23, 2020
f49b053
Update some dependencies
begarco Apr 27, 2020
a3e8be9
Add compatibility matrix #33 (#38)
begarco May 5, 2020
709c149
Fix #39 Update Quality Gate
begarco May 6, 2020
fdebe55
Fix #39 quality gate CNES updated
begarco May 10, 2020
86d4dbc
Fix #41 C tools default report paths were not set
begarco May 10, 2020
0b42487
#35 remove superfluous cppcheck installation
May 10, 2020
c161849
Revert "#35 remove superfluous cppcheck installation"
begarco May 10, 2020
7b27f94
Fix #35 install cppcheck and frama-c from bulleye packages
begarco May 11, 2020
497dc13
Fix #45 Remove useless configuration files
begarco May 12, 2020
b3ff0fb
Fix #39 add new quality gate in configure-cat.sh
begarco May 12, 2020
d2a7eea
Try to correct #30
begarco May 12, 2020
fcafd4d
Update quality profile for C with new cppcheck bugs detection #35
begarco May 12, 2020
ab16c08
Fix #41 at sonar-scanner conf level
begarco May 12, 2020
24612ee
Add tips on GUID in README
begarco May 12, 2020
efb0337
Update Dockerfile by removing unused stage label
begarco May 18, 2020
a5a5967
Clean debian package management & remove lequal email
begarco May 18, 2020
ce73b93
Add details in README on group and permissions
begarco May 19, 2020
aa8e2dd
Merge pull request #46 from lequal/dev-2.1.0
begarco May 19, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report
about: Create a report to help us improve this project
title: ''
labels: bug, to analyse
assignees: ''

---

#### Describe the bug
> _A clear and concise description of what the bug is._

#### To reproduce
> _Steps to reproduce the behavior._
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

#### Expected behavior
> _A clear and concise description of what you expected to happen._

#### Screenshots & log
> If applicable, add screenshots to help explain your problem. Then, append SonarQube log and **do not forget to obfuscate them**._

#### User environment
> _Please complete the following information._
- OS: [e.g. Windows 10]
- Image version: [e.g. 2.0.0]
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for improving this project
title: ''
labels: enhancement, to analyse
assignees: ''

---

#### Is your feature request related to a problem? Please describe.
> _A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_

#### Describe the solution you'd like
> _A clear and concise description of what you want to happen._

#### Describe alternatives you've considered
> _A clear and concise description of any alternative solutions or features you've considered._
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Question
about: Ask a question about the usage of this project
title: ''
labels: question
assignees: ''

---

> _Before posting a new question, please read the [documentation](README.md) and check [existing issues](https://github.com/lequal/docker-cat/issues)._

#### Describe what you need to know
> _A clear and concise description of what your question is._

#### Screenshots & log
> _If applicable, add screenshots to help explain your problem. Then, append SonarQube log and **do not forget to obfuscate them**._

#### User environment
> _Please complete the following information._
- OS: [e.g. Windows 10]
- Image version: [e.g. 2.0.0]
31 changes: 31 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Proposed changes

> _Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue._

## Types of changes

What types of changes does your code introduce to this project?
> _Put an `x` in the boxes that apply_

- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation Update (if none of the other choices apply)

## Issues closed by changes

> _List here all issues closed by your changes. Use a list of items like `- [x] Close #0`_

- [x] Close #0

## Checklist

> _Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._

- [ ] I have read the [CONTRIBUTING](CONTRIBUTING.md) doc
- [ ] I agree with the [CODE OF CONDUCT](CODE_OF_CONDUCT.md)
- [ ] Lint and unit tests pass locally with my changes
- [ ] SonarCloud and Travis CI tests pass with my changes
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)
- [ ] Any dependent changes have been merged and published in downstream modules
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant 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 via GitHub issues. 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][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
79 changes: 79 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Contributing to Frama-C plugin for SonarQube
First off, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to Frama-C plugin for SonarQube, which are hosted in the [Lequal Organization](https://github.com/lequal) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

#### Table Of Contents
+ [Code of Conduct](#code-of-conduct)
+ [How Can I Contribute?](#how-can-i-contribute) 
* [Reporting Bugs](#reporting-bugs) 
* [Suggesting Enhancements](#suggesting-enhancements) 
* [Pull Requests](#pull-requests)
* [Git Commit Messages](#git-commit-messages)

## Code of Conduct
This project and everyone participating in it is governed by the [Lequal Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to administrators via GitHub issues.

## How Can I Contribute?

### Reporting Bugs
Before creating bug reports, please check if the problem has already been reported.

#### How Do I Submit A (Good) Bug Report?
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
Provide information by filling [the template](.github/ISSUE_TEMPLATE/bug_report.md).

Explain the problem and include additional details to help maintainers reproduce the problem:
* **Use a clear and descriptive title** for the issue to identify the problem.
* **Describe the exact steps which reproduce the problem** in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, which you use in those examples.
* **Explain which behavior you expected and describe the behavior you observed** after following the steps and point out what exactly is the problem with that behavior.
* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
* **If you're reporting that the plugin crashed**, include a crash report with a stack trace from the operating system.

Provide more context by answering these questions:
* **Did the problem start happening recently** (e.g. after updating to a new version of the plugin or SonarQube) or was this always a problem?
* If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen? You can download older versions from [the releases page](https://github.com/lequal/docker-cat/releases).
* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:
* **Which SonarQube version are you using?** You can get the exact version at the bottom of your SonarQube instance.

### Suggesting Enhancements
Before creating enhancement suggestions, please check if the problem has already been suggested.

#### How Do I Submit A (Good) Enhancement Suggestion?
Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). To submit en enhancement suggestion, create an issue and provide the following information:
* **Use a clear and descriptive title** for the issue to identify the suggestion.
* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
* **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of Atom which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
* **Explain why this enhancement would be useful**
* **Specify which version you're using.**
* **Specify the SonarQube version you're using.** The SonarQube version is mentioned at the bottom of the web page.

### Pull Requests
* Fill in [the required template](.github/PULL_REQUEST_TEMPLATE.md)
* Do not include issue numbers in the PR title
* Include screenshots and animated GIFs in your pull request whenever possible
* Follow the Java styleguides and fix all new SonarCloud issues
* Test your code before opening the PR
* Set the current `dev-*` or `develop` branch as the target branch for your PR

### Git Commit Messages
* Start with the issue you are handling ("#187 ...")
* Use the present tense ("Add feature" not "Added feature")
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
* Limit the first line to 72 characters or less
* Reference issues and pull requests liberally after the first line
* When only changing documentation, include `[ci skip]` in the commit description

## Management of contributions

All contributions are welcome. They are made via a *pull request* on the branch `develop` which is the branch of the next version.

* pull request with **major** changes must be approved by at least one maintainer of each team and the LEQUAL.

* pull requests with **minor** changes must be approved by at least one organization's member.

All maintainers have the ability to merge *pull requests* on the `dev` branch. If several maintainers belong to the same team, their validation only counts for one organization.
Loading