Skip to content

Commit

Permalink
chore: update CONTRIBUTING.md for better readability
Browse files Browse the repository at this point in the history
  • Loading branch information
@ariwk
ariwk authored Apr 30, 2024
1 parent 2ae7518 commit 25bed20
Showing 1 changed file with 28 additions and 46 deletions.
74 changes: 28 additions & 46 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,77 +7,68 @@ These are mostly guidelines, not rules. Use your best judgment, and feel free to

[Prerequisites](#prerequisites)

[I just have a question!](#i-just-have-a-question)
[Ask a question](#ask-a-question)

[What should I know before I get started?](#what-should-i-know-before-i-get-started)
* [Tools and Packages](#tools-and-packages)
* [Design Decisions](#design-decisions)

[How Can I Contribute?](#how-can-i-contribute)
* [Issues and Bugs](#issue)
* [Feature Requests](#feature)
- [Commit Message Guidelines](#commit)
* [Reporting Bugs](#bugs)
* [Suggesting Enhancements](#enhancements)
* [Submitting Changes](#submit-pr)
* [Pull Requests Guidelines](#submit-pr)
* [Submitting a Pull Request (PR)](#submit-pr)
* [Coding Rules](#rules)
* [Commit Message Guidelines](#commit)
* [Your First Code Contribution](#your-first-code-contribution)

## <a id="code-of-conduct"></a>Code of Conduct
This project and everyone participating in it are governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [polarion-opensource(at)sbb.ch].

#ToDo --> should we expose our email?
## <a id="prerequisites"></a>Prerequisites
All contributors must have an active Polarion license. An active Polarion license means that the contributor has access to a valid Polarion license issued by Siemens, including but not limited to customer, partner, academic, trial, or demo Polarion license.

## <a id="i-just-have-a-question"></a>I just have a question!
## <a id="ask-a-question"></a>Asking questions
#ToDo --> discussion or issue?
Join the conversation! Please ask questions in the discussions [here](../../discussions)

We use GitHub for tracking bugs and feature requests related to this extension.
Do not know how something in this project works? Curious if this project can achieve your desired functionality? Please [submit an issue](../../issues/new) with the label `question`.
## <a id="what-should-i-know-before-i-get-started"></a>What should I know before I get started?

### <a id="tools-and-packages"></a>Tools and Packages
All extensions provided by SBB Polarion Team can be built, tested and packaged using Maven.
It is only possible when the dependencies are extract from Polarion installer. The process must be performed by each contributor. Please consider to use **TODO --> ADD LINK TO OUR PYTHON UTILITY** to extract the dependencies for your own Polarion installer version.

### <a id="design-decisions"></a>Design Decisions
The common implementation for each extension provided by SBB Polarion Team is located in [ch.sbb.polarion.extension.generic](https://github.com/SchweizerischeBundesbahnen/ch.sbb.polarion.extension.generic)

The common implementation for extensions provided by SBB Polarion Team is located in [ch.sbb.polarion.extension.generic](https://github.com/SchweizerischeBundesbahnen/ch.sbb.polarion.extension.generic)
## <a id="how-can-i-contribute"></a>How Can I Contribute?

### <a id="issue"></a>Issues and Bugs
If you find a bug in the source code or a mistake in the documentation, you can help us by [submitting an issue](#submit-issue) to our [GitHub Repository](../../issues/new). Including an issue reproduction (via StackBlitz, JsBin, Plunkr, etc.) is the absolute best way to help the team quickly diagnose the problem. Screenshots are also helpful.

You can help the team even more and [submit a Pull Request](#submit-pr) with a fix.

### <a id="feature"></a>Feature Request
You can *request* a new feature by [submitting an issue](#submit-issue) to our [GitHub Repository](../../issues/new).
If you would like to *implement* a new feature, please submit an issue with
a proposal for your work first, to be sure that we can use it.
Please consider what kind of change it is:

* For a **Major Feature**, first open an issue and outline your proposal so that it can be
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
and help you to craft the change so that it is successfully accepted into the project.
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
### <a id="commit"></a>Commit Message Guidelines
This project uses [Conventional Commits](https://www.conventionalcommits.org/) to generate the Changelog using the [Release Please GitHub action](.github/workflows/release-please.yml)
For comprehensive information, please consult the [Release Please documentation](https://github.com/googleapis/release-please).
### <a id="bugs"></a>Reporting Bugs
To report a bug, [submit an issue](../../issues/new) with the label `bug`. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](./SECURITY.md).**

### <a id="submit-issue"></a>Submitting an Issue
If your issue appears to be a bug, and hasn't been reported, open a new issue.
Providing the following information will increase the
chances of your issue being dealt with quickly:
Providing the following information will increase the chances of your issue being dealt with quickly:

* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
* **Toolchain and Environment Details** - which versions of libraries, toolchain, platform etc
* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior
is a bug for you
* **Browsers and Operating System** - is this a problem with all browsers?
* **Reproduce the Error** - provide a live example (using StackBlitz or similar) or a unambiguous set of steps
* **Screenshots** - maybe screenshots can help the team
triage issues far more quickly than a text description.
* **Reproduce the Error** - provide a live example or a unambiguous set of steps
* **Screenshots** - maybe screenshots can help the team to triage issues far more quickly than a text description
* **Related Issues** - has a similar issue been reported before?
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
causing the problem (line of code or commit)

You can file new issues by providing the above information [here](../../issues/new).
You can help the team even more by [submitting a Pull Request](#submit-pr) with a fix.
### <a id="enhancements"></a>Suggesting Enhancements
To suggest a feature or enhancement, please [submit an issue](../../issues/new) with the label `enhancement`. Please ensure the feature or enhancement has not already been suggested.

Please consider what kind of change it is:

* For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).

### <a id="submit-pr"></a>Submitting a Pull Request (PR)
### <a id="submit-pr"></a>Submitting Changes
Before you submit your Pull Request (PR) consider the following guidelines:

* Make your changes in a new git branch:
Expand Down Expand Up @@ -115,12 +106,3 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
* All public API methods **must be documented**.
* Also see [CODING_STANDARDS](./CODING_STANDARDS.md)

### <a id="commit"></a>Commit Message Guidelines
This project uses [Conventional Commits](https://www.conventionalcommits.org/) to generate the Changelog using the [Release Please GitHub action](.github/workflows/release-please.yml)
For comprehensive information, please consult the [Release Please documentation](https://github.com/googleapis/release-please).

### <a id="your-first-code-contribution"></a>Your First Code Contribution
Unsure where to begin contributing to Atom? You can start by looking through these `beginner` and `help-wanted` issues:

* [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
* [Help wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues.

0 comments on commit 25bed20

Please sign in to comment.