Skip to content

Commit 22c8225

Browse files
author
labo
committed
Add contributing.md
1 parent 0e3f532 commit 22c8225

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

CONTRIBUTING.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Contributing to sonar-icode-cnes-plugin
2+
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4+
5+
The following is a set of guidelines for contributing to sonar-icode-cnes-plugin, 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.
6+
7+
#### Table Of Contents
8+
9+
[Code of Conduct](#code-of-conduct)
10+
11+
[How Can I Contribute?](#how-can-i-contribute)
12+
* [Reporting Bugs](#reporting-bugs)
13+
* [Suggesting Enhancements](#suggesting-enhancements)
14+
* [Pull Requests](#pull-requests)
15+
16+
[Git Commit Messages](#git-commit-messages)
17+
18+
[Additional Notes](#additional-notes)
19+
* [Issue and Pull Request Labels](#issue-and-pull-request-labels)
20+
21+
## Code of Conduct
22+
23+
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 [[email protected]](mailto:[email protected]).
24+
25+
## How Can I Contribute?
26+
27+
### Reporting Bugs
28+
29+
Before creating bug reports, please check if the problem has already been reported.
30+
31+
#### How Do I Submit A (Good) Bug Report?
32+
33+
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Provide information by filling [the template](ISSUE_TEMPLATE.md).
34+
35+
Explain the problem and include additional details to help maintainers reproduce the problem:
36+
37+
* **Use a clear and descriptive title** for the issue to identify the problem.
38+
* **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.
39+
* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, which you use in those examples.
40+
* **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.
41+
* **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.
42+
* **If you're reporting that the plugin crashed**, include a crash report with a stack trace from the operating system.
43+
44+
Provide more context by answering these questions:
45+
46+
* **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?
47+
* 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/sonar-icode-cnes-plugin/releases).
48+
* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
49+
50+
Include details about your configuration and environment:
51+
52+
* **Which SonarQube version are you using?** You can get the exact version at the bottom of your SonarQube instance.
53+
54+
### Suggesting Enhancements
55+
56+
Before creating enhancement suggestions, please check if the problem has already been suggested.
57+
58+
#### How Do I Submit A (Good) Enhancement Suggestion?
59+
60+
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:
61+
62+
* **Use a clear and descriptive title** for the issue to identify the suggestion.
63+
* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
64+
* **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).
65+
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
66+
* **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.
67+
* **Explain why this enhancement would be useful**
68+
* **Specify which version you're using.**
69+
* **Specify the SonarQube version you're using.** The SonarQube version is mentionned at the bottom of the web page.
70+
71+
### Pull Requests
72+
73+
* Fill in [the required template](PULL_REQUEST_TEMPLATE.md)
74+
* Do not include issue numbers in the PR title
75+
* Include screenshots and animated GIFs in your pull request whenever possible.
76+
* Follow the Java styleguides.
77+
78+
## Git Commit Messages
79+
80+
* Use the present tense ("Add feature" not "Added feature")
81+
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
82+
* Limit the first line to 72 characters or less
83+
* Reference issues and pull requests liberally after the first line
84+
* When only changing documentation, include `[ci skip]` in the commit description

0 commit comments

Comments
 (0)