Skip to content

guidelines: add repository #848

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 29, 2018
Merged

guidelines: add repository #848

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
909db13
guidelines: add repository
0xc0170 Nov 26, 2018
d5dfb2c
Edit guidelines.md
Nov 29, 2018
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
16 changes: 12 additions & 4 deletions docs/reference/contributing/guidelines/guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

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:

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

### Access to the ARMmbed organisation on GitHub
### Access to the ARMmbed organization on GitHub

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

Expand All @@ -19,3 +19,11 @@ If so, you can request to become an organization member, but you must first ensu
- All users must have 2 Factor Authentication enabled.
- Arm staff must have their Name, Company (Arm), Location and Arm email address publicly visible.
- All others should have their Name and Company visible. Entering your Location will help us interpret response times according to time zones.

### New repository

Each repository must contain:

- `CONTRIBUTING.md` file (similar to [Mbed OS contributing](https://github.com/ARMmbed/mbed-os/blob/master/CONTRIBUTING.md)).
- `LICENSE` file - the full license text or overview of every license in the repo with links.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might not be a question for this PR, but do we need to specify which kind of licenses should be used?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we add a link here to license page ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, yes!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* Licenses: Licenses should comply with the [licenses described here](../contributing/license.html). is above in the first section, should be sufficient for this page

- `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)).