Skip to content

Commit efb38bb

Browse files
committed
[Admin] Add : Code of conduct ; Contribution guidelines ; Security guidance ; PR & Issues templates
1 parent a620f27 commit efb38bb

File tree

5 files changed

+186
-0
lines changed

5 files changed

+186
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: 'Issue report'
3+
about: 'Create a report to help us improve the quality of our software'
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
**Caution**
10+
11+
The Issues are strictly limited for the reporting of problem encountered with the software provided in this project.
12+
For any other problem related to the STSAFE product, the performance, the hardware characteristics and boards, the tools the environment in general, please post your report to the **ST Community** on the appropriate topic [page](https://community.st.com/s/topiccatalog).
13+
14+
**Describe the set-up**
15+
* Target Secure Element from STMicroelectronics
16+
* The board (either ST RPN reference or your custom board)
17+
* IDE or at least the compiler and its version
18+
19+
**Describe the bug (skip if none)**
20+
21+
A clear and concise description of what the bug is.
22+
23+
**How to reproduce the bug (skip if none)**
24+
25+
1. Indicate the global behavior of your application project
26+
2. List the SW modules that you suspect to be the cause of the problem
27+
3. Describe the use case that generates the problem
28+
4. How we can reproduce the problem
29+
30+
31+
**Additional context**
32+
33+
If you have a first analysis, an enhancement, a fix or a patch, thank you to share your proposal.
34+
35+
**Screenshots**
36+
37+
If applicable, add screenshots to help explain your problem.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## IMPORTANT INFORMATION
2+
3+
### Contributor License Agreement (CLA)
4+
* The Pull Request feature will be considered by STMicroelectronics after the signature of a **Contributor License Agreement (CLA)** by the submitter.
5+
* If you did not sign such agreement, please follow the steps mentioned in the [CONTRIBUTING.md](CONTRIBUTING.md) file.

CODE_OF_CONDUCT.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team via this [link](https://www.st.com/content/st_com/en/contact-us.html).
59+
All complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
71+
available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
72+
73+
For answers to common questions about this code of conduct, refer to the FAQ section [here](https://www.contributor-covenant.org/faq).

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing guide
2+
3+
This guide serves as a checklist before contributing to this repository. It mainly focuses on the steps to follow to submit an issue or a pull-request.
4+
5+
## 1. Issues
6+
7+
### 1.1 Before opening an issue
8+
9+
Please check the following points before posting an issue:
10+
* Make sure you are using the latest commit (major releases are tagged, but corrections are available as new commits).
11+
* Make sure your issue is a question/feedback/suggestions **related to** the software provided in this repository. Otherwise, please refer to section [3](CONTRIBUTING.md#3-support-requests-and-questions) below.
12+
* Make sure your issue is not already reported/fixed on GitHub or discussed on a previous issue. Do not forget to browse into the **closed** issues.
13+
14+
### 1.2 Posting the issue
15+
16+
When you have checked the previous points, create a new report from the **Issues** tab of this repository. A template is available [here](../../issues/new/choose) to help you report the issue you are facing or the enhancement you would like to propose.
17+
18+
## 2. Pull Requests
19+
20+
### 2.1 Before opening a pull-request
21+
22+
STMicrolectronics is happy to receive contributions from the community, based on an initial Contributor License Agreement (CLA) procedure.
23+
24+
* If you are an individual writing original source code and you are sure **you own the intellectual property**, then you need to sign an Individual [CLA](https://cla.st.com).
25+
* If you work for a company that wants also to allow you to contribute with your work, your company needs to provide a Corporate [CLA](https://cla.st.com) mentioning your GitHub account name.
26+
* If you are not sure that a CLA (Individual or Corporate) has been signed for your GitHub account you can check the [CLA](https://cla.st.com) dedicated page.
27+
28+
Please note that:
29+
* The Corporate CLA will always take precedence over the Individual CLA.
30+
* One CLA submission is sufficient, for any project proposed by STMicroelectronics.
31+
32+
### 2.2 How to proceed
33+
34+
* We recommend to engage first a communication thru an issue, in order to present your proposal, just to confirm that it corresponds to STMicroelectronics' domain or scope.
35+
* Then fork the project to your GitHub account to further develop your contribution. Please use the latest commit version.
36+
* Please, submit one pull-request per new feature or proposal. This will ease the analysis and the final merge if accepted.
37+
38+
## 3. Support requests and questions
39+
40+
For support requests or any other question related to the product, the tools, the environment, you can submit a post to the **ST Community** on the appropriate topic [page](https://community.st.com/s/topiccatalog).

SECURITY.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Report potential product security vulnerabilities
2+
3+
ST places a high priority on security, and our Product Security Incident
4+
Response Team (PSIRT) is committed to rapidly addressing potential security
5+
vulnerabilities affecting our products. PSIRT's long history and vast experience
6+
in security allows ST to perform clear analyses and provide appropriate guidance
7+
on mitigations and solutions when applicable.
8+
9+
If you wish to report potential security vulnerabilities regarding our products,
10+
**please do not report them through public GitHub issues.** Instead, we
11+
encourage you to report them to our ST PSIRT following the process described at:
12+
**https://www.st.com/content/st_com/en/security/report-vulnerabilities.html**
13+
14+
### IMPORTANT - READ CAREFULLY:
15+
16+
STMicroelectronics International N.V., on behalf of itself, its affiliates and
17+
subsidiaries, (collectively “ST”) takes all potential security vulnerability
18+
reports or other related communications (“Report(s)”) seriously. In order to
19+
review Your Report (the terms “You” and “Yours” include your employer, and all
20+
affiliates, subsidiaries and related persons or entities) and take actions as
21+
deemed appropriate, ST requires that we have the rights and Your permission to
22+
do so.
23+
24+
As such, by submitting Your Report to ST, You agree that You have the right to
25+
do so, and You grant to ST the rights to use the Report for purposes related to
26+
security vulnerability analysis, testing, correction, patching, reporting and
27+
any other related purpose or function.
28+
29+
By submitting Your Report, You agree that ST’s
30+
[Privacy Policy](https://www.st.com/content/st_com/en/common/privacy-portal.html)
31+
applies to all related communications.

0 commit comments

Comments
 (0)