guidelines: add repository #848
Conversation
|
Note, Mbed OS repository follows this. Not all examples but at least some new ones do. |
0xc0170
force-pushed
the
fix_repository_guide
branch
2 times, most recently
from
0cdd1ed to
ba77db5
Compare
Each repo should contain license & contributing information
0xc0170
force-pushed
the
fix_repository_guide
branch
from
ba77db5 to
909db13
Compare
|
I fixed the links |
| 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. |
There was a problem hiding this comment.
Might not be a question for this PR, but do we need to specify which kind of licenses should be used?
There was a problem hiding this comment.
Shall we add a link here to license page ?
There was a problem hiding this comment.
* Licenses: Licenses should comply with the [licenses described here](../contributing/license.html). is above in the first section, should be sufficient for this page
|
One thing I noticed - our repos ar emissing templates for issues/pull requests. As a guidance, we might want to document these two. See an example here : ARMmbed/mbed-os-example-mbed-crypto#5 I can send separate PR based on this one to extend what repository should follow. These templates should be a must / should contain. So our scripts work (cloning issues), etc |
Fix existing typo, and spell out symbol for consistent style.
Each repo should contain license & contributing information
I added it to the guidelines (new section - new repository). This should be valid for any repository we release. 3 files that are important for contribution.
@ARMmbed/mbed-os-maintainers Please review