Skip to content

Commit fcaca14

Browse files
author
Amanda Butler
authored
Merge pull request #848 from 0xc0170/fix_repository_guide
guidelines: add repository
2 parents bc10408 + d5dfb2c commit fcaca14

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/reference/contributing/guidelines/guidelines.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Consistency is an important aspect of a codebase. To ensure consistency in Mbed OS code, we have created contributing guidelines. Any contribution to Mbed OS needs to meet the following criteria:
44

5-
* Design and coding style: Be consistent with your changes. We define software design principles and coding style in [this document](../contributing/style.html).
6-
* Contributions guidance: The process and how we review contributions is described in the [workflow](../contributing/workflow.html) document.
7-
* Licenses: Licenses should comply with the [licenses described here](../contributing/license.html).
5+
- Design and coding style: Be consistent with your changes. We define software design principles and coding style in [this document](../contributing/style.html).
6+
- Contributions guidance: The process and how we review contributions is described in the [workflow](../contributing/workflow.html) document.
7+
- Licenses: Licenses should comply with the [licenses described here](../contributing/license.html).
88

9-
### Access to the ARMmbed organisation on GitHub
9+
### Access to the ARMmbed organization on GitHub
1010

1111
You might require direct access to the ARMmbed organization for one of the following reasons:
1212

@@ -19,3 +19,11 @@ If so, you can request to become an organization member, but you must first ensu
1919
- All users must have 2 Factor Authentication enabled.
2020
- Arm staff must have their Name, Company (Arm), Location and Arm email address publicly visible.
2121
- All others should have their Name and Company visible. Entering your Location will help us interpret response times according to time zones.
22+
23+
### New repository
24+
25+
Each repository must contain:
26+
27+
- `CONTRIBUTING.md` file (similar to [Mbed OS contributing](https://github.com/ARMmbed/mbed-os/blob/master/CONTRIBUTING.md)).
28+
- `LICENSE` file - the full license text or overview of every license in the repo with links.
29+
- `README.md` has a license and contributing section (similar to [Mbed OS license and contributions section](https://github.com/ARMmbed/mbed-os/blob/master/README.md#license-and-contributions)).

0 commit comments

Comments
 (0)