Skip to content

Commit d4f65d9

Browse files
committed
Expanded Contribution Guidelines.
(cherry picked from commit 7179e82c3bea872273741f2eb4e4e2ab7ccb4e0c, f6510dc3b81b8272e3df46f3848cf95f1a643542)
1 parent ef9fec8 commit d4f65d9

File tree

2 files changed

+45
-7
lines changed

2 files changed

+45
-7
lines changed

Diff for: CONTRIBUTING.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing
2+
3+
Thank you for your interest in this project! We want to encourage individuals and organisations to be involved in its ongoing development as users and contributors.
4+
5+
## Issues
6+
7+
We welcome bug reports and feature requests for the implementation. These should be submitted as Issues on GitHub:
8+
9+
- [Sign up](https://github.com/join) for GitHub if you haven't already done so.
10+
- Check whether someone has already submitted a similar Issue.
11+
- If necessary, submit a new Issue.
12+
13+
Good bug reports will include a clear title and description, as much relevant information as possible, and preferably a code sample or an executable test case demonstrating the expected behavior that is not occurring.
14+
15+
## Pull Requests
16+
17+
You can submit bug fixes, patches and other improvements to the code or documentation for review through a GitHub pull request as follows:
18+
19+
* Fork the repository.
20+
* Make and commit changes.
21+
* Push your changes to a topic branch in your fork.
22+
* Make sure you understand how the repository licence applies to pull requests (see below).
23+
* Submit a pull request.
24+
25+
Good PRs will include a clear rationale for the patch, and should follow the style of the existing code or documentation in this area.
26+
27+
## Licence Agreement
28+
29+
To make the process of contributing as simple as possible, we do not require contributors to have signed a Contributor Licence Agreement (CLA).
30+
31+
As GitHub says in its [Terms of Service](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license), *"Whenever you make a contribution to a repository containing notice of a license, you license your contribution under the same terms, and you agree that you have the right to license your contribution under those terms. [...] This is widely accepted as the norm in the open-source community; it's commonly referred to by the shorthand "inbound=outbound"."*
32+
33+
All submissions are therefore made under the terms and conditions of the widely-used Apache License 2.0 with which this repository is [licensed](LICENSE). In brief, it explains that you must be authorised to submit on behalf of the copyright owner and that you simply grant the project's users, maintainers and contributors the same ability to use your submission as the rest of the repository.
34+
35+
## Joining the AMWA Networked Media Incubator
36+
37+
If you wish to get more involved in creating NMOS specifications, working to implement and improve them, and participating in "plugfests", then your organisation may benefit from joining the [Advanced Media Workflow Association (AMWA)](http://amwa.tv/).
38+

Diff for: README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,23 @@ Other open-source NMOS implementations:
3636

3737
### Active Development
3838

39-
The **nmos-cpp-node** example application has been recently added, as well as cross-platform build support using CMake.
39+
Recent activity on the project:
40+
41+
- Cross-platform build support using CMake
42+
- An initial release of the **nmos-cpp-node** example application
43+
- Back-end enhancements as part of the NMOS Scalability Activity
4044

4145
In the next few weeks, we intend to bring to this repository:
4246

47+
- Instructions for configuring a CMake toolchain for cross-compiling for embedded Linux on ARM
4348
- More of a unit test suite, and automated integration testing (the [AMWA NMOS Automated Testing](https://github.com/AMWA-TV/nmos-automated-testing) Activity is also a work in progress)
4449
- Additional documentation
45-
- Back-end enhancements as part of the NMOS Scalability Activity
4650

4751
And of course, the software will continue to be updated to track the ongoing development of the NMOS specifications, and the work of the Networked Media Incubator.
4852

4953
## Contributing
5054

51-
We welcome bug reports and feature requests for the implementation. These should be submitted as Issues on GitHub:
52-
53-
- [Sign up](https://github.com/join) for GitHub if you haven't already done so.
54-
- Check whether someone has already submitted a similar Issue.
55-
- If necessary, submit a new Issue.
55+
We welcome bug reports, feature requests and contributions to the implementation and documentation. Please have a look at the simple [Contribution Guidelines](CONTRIBUTING.md).
5656

5757
Thank you for your interest!
5858

0 commit comments

Comments
 (0)