Jump to: navigation, search

Difference between revisions of "Contributor Guidelines"

 
Line 1: Line 1:
 
New contributors and project proposals are welcomed.
 
New contributors and project proposals are welcomed.
  
As can be seen at this point the guidelines are fairly minimal! However, there are plans to develop these in due course and if you are interested in contributing to this effort, please introduce yourself via the [https://discourse.myriadrf.org/c/governance Governance Forum].
+
If you have any questions or are interested in helping us develop our approach to governance, please introduce yourself via the [https://discourse.myriadrf.org/c/governance Governance Forum].
 +
 
 +
== Projects ==
  
 
=== Contributing to existing projects ===
 
=== Contributing to existing projects ===
Line 17: Line 19:
 
* Designs for RF components such as amplifiers and filters;
 
* Designs for RF components such as amplifiers and filters;
 
* RF component footprint libraries.
 
* RF component footprint libraries.
 +
 +
==== Copyright ====
 +
 +
For details of contributor responsibility please see the [https://myriadrf.org/terms-conditions/ Terms and Conditions].
 +
 +
Note that we do not require contributors to assign their copyrights to us.
  
 
==== Licensing ====
 
==== Licensing ====
  
It goes without saying that projects must use recognised open source licences.  
+
Projects must use recognised open source licences.  
  
 
In general we favour:
 
In general we favour:
Line 37: Line 45:
 
This will take the form of a discussion and we will be as open and transparent as we can.
 
This will take the form of a discussion and we will be as open and transparent as we can.
  
''Formal process TBD and we welcome suggestions!''
+
''Formal process TBD and suggestions are welcomed!''
 +
 
 +
== Device documentation ==
 +
 
 +
This wiki is also used to host device documentation in an effort to make it more accessible and easier to reuse. This is organised in dedicated namespaces that are distinct from the main "community" namespace (which is actually the default/main namespace that does not have a prefix).
 +
 
 +
At the present time the following vendors host documentation on this wiki:
 +
 
 +
* [[LimeMicro:Welcome|Lime Microsystems]]
 +
 
 +
 
 +
Other device vendors are welcome to host documentation with us, subject to providing proof that a contributor is an authorised employee or agent of that vendor.
 +
 
 +
Proposals should be sent in the first instance to [mailto:a.back@limemicro.com Andrew Back].
  
 
{{Community}}
 
{{Community}}

Latest revision as of 17:14, 15 September 2015

New contributors and project proposals are welcomed.

If you have any questions or are interested in helping us develop our approach to governance, please introduce yourself via the Governance Forum.

1 Projects

1.1 Contributing to existing projects

Those interested in contributing to an existing project should introduce themselves via the associated discussion forum.

1.2 New project proposals

Please note that these guidelines are very much a work in progress.

1.2.1 Scope

Our primary focus is SDR hardware and associated software, but additional areas that may be considered to be a good fit include:

  • Designs for RF components such as amplifiers and filters;
  • RF component footprint libraries.

1.2.2 Copyright

For details of contributor responsibility please see the Terms and Conditions.

Note that we do not require contributors to assign their copyrights to us.

1.2.3 Licensing

Projects must use recognised open source licences.

In general we favour:

  • Creative Commons Attribution for hardware designs
  • Apache 2.0 for software.

However, we are not closed to projects which propose to use other licences.

1.2.4 Submission

Proposals should be sent in the first instance to Andrew Back.

1.2.5 Review process

This will take the form of a discussion and we will be as open and transparent as we can.

Formal process TBD and suggestions are welcomed!

2 Device documentation

This wiki is also used to host device documentation in an effort to make it more accessible and easier to reuse. This is organised in dedicated namespaces that are distinct from the main "community" namespace (which is actually the default/main namespace that does not have a prefix).

At the present time the following vendors host documentation on this wiki:


Other device vendors are welcome to host documentation with us, subject to providing proof that a contributor is an authorised employee or agent of that vendor.

Proposals should be sent in the first instance to Andrew Back.