Skip to content

Commit 24b250b

Browse files
author
Amanda Butler
authored
Make edits to guidelines.md
Apply changes from PR #1064 to v5.12.
1 parent f598fc3 commit 24b250b

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

docs/reference/contributing/guidelines/guidelines.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,35 @@ To encourage collaboration, as well as robust, consistent and maintainable code,
88

99
## How to contribute 
1010

11-
Mbed OS has a team of maintainers who provide guidance and direction to contributors. This team is responsible for helping you get your changes in, as well as controlling the overall quality and consistency of the software. For more information about the maintainers and their responsibilities, please see [our workflow](https://os.mbed.com/docs/v5.12/contributing/workflow.html#mbed-os-maintainers).
11+
Mbed OS has a team of maintainers who provide guidance and direction to contributors. This team is responsible for helping you get your changes in, as well as controlling the overall quality and consistency of the software.
1212

13-
We accept contributions in the form of pull requests. Each pull request must be reviewed by at least one other developer experienced with the functionality. For contributions that span multiple functionalities, multiple reviewers may be necessary. After reviews are complete, we test the changes as part of a larger system. The testing includes but is not limited to: functional correctness, static analysis, integration with other parts of the system, code style or formatting and regressions, such as code size increase or performance degredation. If any of the testing fails, more work will be needed before we accept the contribution. For more information about how to contribute, please see [our workflow](https://os.mbed.com/docs/v5.12/contributing/workflow.html#mbed-os-maintainers).
13+
We accept contributions in the form of pull requests. Each pull request must be reviewed by at least one other developer experienced with the functionality. For contributions that span multiple functionalities, multiple reviewers may be necessary. After reviews are complete, we test the changes as part of a larger system. The testing includes but is not limited to: functional correctness, static analysis, integration with other parts of the system, code style or formatting and regressions, such as code size increase or performance degredation. If any of the tests fail, more work will be needed before we accept the contribution. For more information about how to contribute, please see [our workflow](../contributing/workflow.html#mbed-os-maintainers).
1414

1515
## Types of contributions 
1616

17-
There are a few [types of contributions](../contributing/workflow.html#pull-request-types). Each type has different priorities and requirements. When contributing, it’s important not to mix types and instead to create multiple contributions if needed. The type of contribution affects how and when it is incorporated into Mbed OS.
17+
There are a few [types of contributions](../contributing/workflow.html#pull-request-types). Each type has different priorities and requirements. When contributing, it’s important not to mix types and instead, create multiple contributions if needed. The type of contribution affects how and when it is incorporated into Mbed OS.
1818

1919
## Licensing 
2020

21-
A license is the contract between the author permitting the use of software to others. It specifies what you can and cannot do when receiving the software. It provides protection for both the user and owner of the software. In an Mbed project, you can find the full terms of the license in a file named LICENSE. Additionally, all source files must contain the SPDX identifier as a comment at the beginning of the file.
21+
A license is the contract between the user and owner of the software. It specifies what you can and cannot do when receiving the software. It provides protection for both the user and owner. In an Mbed project, the full terms of the license are in a file named LICENSE. Additionally, all source files must contain the SPDX identifier as a comment at the beginning of the file.
2222

23-
Note that one repository may contain multiple, independent code bases, each with their own license. If you are integrating two libraries with different licenses, it is important that each library retain its original license. If a repository has software with multiple licenses, the contribution will be made according to the license of the file the contribution modifies. By creating a pull request on GitHub, you are agreeing to license your contributions under the same license as the original code. This is commonly referred to as "inbound=outbound". This enables contributions to happen in a quick and effortless way and encourages collaboration. 
23+
One repository may contain multiple, independent code bases, each with their own license. If you are integrating two libraries with different licenses, it is important that each library retain its original license. If a repository has software with multiple licenses, the contribution will be made according to the license of the file the contribution modifies. By creating a pull request on GitHub, you agree to license your contributions under the same license as the original code. This is commonly referred to as "inbound=outbound". This enables contributions to happen in a quick and effortless way and encourages collaboration. 
2424

2525
Most Mbed OS software is licensed under a permissive license. The three most common permissive licenses are:
2626

2727
- Apache 2.0.
2828
- BSD 3-Clause.
2929
- MIT.
3030

31-
For new Mbed projects, we suggest adopting the Apache 2.0 license. Note that any Mbed software release under a permissive license cannot accept any code that is licensed under a "copyleft" license. Doing so would prevent us from continuing to distribute our code under the permissive license. You are welcome to use Mbed software with copyleft licenses, as long as the rules of the copyleft license are followed.
31+
For new Mbed projects, we suggest adopting the Apache 2.0 license.
3232

33-
You can find a more detailed description on licenses in the [contributing guidelines](../contributing/license.html).
33+
<span class="notes">**Note:** An Mbed software release under a permissive license cannot accept any code that is licensed under a "copyleft" license. Doing so would prevent us from distributing our code under the permissive license. You are welcome to use Mbed software with copyleft licenses, as long as you follow the rules of the copyleft license.</span>
34+
35+
Please, see the [contributing guidelines](../contributing/license.html) for a more detailed description of licenses.
3436

3537
## Access to the ARMmbed organization on GitHub
3638

37-
You might require direct access to the ARMmbed organization for one of the following reasons:
39+
You may require direct access to the ARMmbed organization for one of the following reasons:
3840

3941
- You need access to private repositories.
4042
- You need push access to a repository.
@@ -52,16 +54,16 @@ When leaving the organization, please follow these [best practices](https://help
5254

5355
## Creating new repositories
5456

55-
If you create a new repository in the ARMmbed organization on GitHub, it must follow some rules. Each repository must contain a:
57+
If you create a new repository in the ARMmbed organization on GitHub, it must contain a:
5658

5759
- `CONTRIBUTING.md` file (similar to [Mbed OS contributing](https://github.com/ARMmbed/mbed-os/blob/master/CONTRIBUTING.md)).
5860
- `LICENSE` file, the full license text or overview of every license in the repository with links.
5961
- `README.md` with 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)).
6062

6163
## Tips 
6264

63-
- The maintainers and reviewers are your friends. At times, programming can be personal. However, it's important to realize that we all share a common goal and that honest feedback is constructive feedback.
64-
- Larger contributions take longer to be accepted than smaller contributions. The best contributions are small and purposeful, achieving a single goal. We may ask you to split up a contribution if it contains multiple unrelated changes.
65+
- The maintainers and reviewers are your friends. At times, programming can be personal. However, it's important to realize that we all share a common goal and honest feedback is constructive feedback.
66+
- Larger contributions take longer to be accepted than smaller ones. The best contributions are small and purposeful, achieving a single goal. We may ask you to split up a contribution if it contains multiple unrelated changes.
6567
- Consistency is an important aspect of a code base. To ensure consistency in Mbed OS code, we have created contributing guidelines. Any contribution to Mbed OS needs to meet the following criteria:
66-
- Design and coding style: Be consistent with your changes. The existing style of a code base overrules any personal preference. We define software design principles and coding style in [the style](../contributing/style.html) and [software design](../contributing/software-design.html) guidelines.
67-
- Contributions guidance: The [workflow](../contributing/workflow.html) document describes the contribution process and how we review contributions.
68+
- Be consistent with your changes. The existing style of a code base overrules any personal preference. We define the [software design principles](../contributing/software-design.html) and [coding style guidelines](../contributing/style.html).
69+
- Follow the [contribution workflow](../contributing/workflow.html). It explains the contribution process.

0 commit comments

Comments
 (0)