You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
-
# The NSO Developer organization on GitHub
1
+
# The NSO Developer space on GitHub
2
2
3
-
We have created a public organization on GitHub to ensure we have one common place to share code for all of us working with NSO.
3
+
We have created a public space on GitHub to ensure we have one common place to share code for all of us working with NSO.
4
4
5
-
Since the NSO Developer organization is a public GitHub everyone can fork and read the uploaded code.
5
+
Since the NSO Developer space is a public GitHub everyone can fork and read the uploaded code.
6
6
By using a pull request everyone can also contribute to existing projects.
7
7
8
8
If you want to contribute with a new project, please read the instructions below.
9
9
10
10
## Licenses
11
-
All material on the NSO Developer organization on GitHub is under the [Apache 2.0 license](https://github.com/NSO-developer/NSO-developer/blob/master/LICENSE).
11
+
All material on the NSO Developer space on GitHub is under the [Apache 2.0 license](https://github.com/NSO-developer/NSO-developer/blob/master/LICENSE).
12
12
The license is used to ensure a balance between open contribution and allowing you to use the software as you like to.
13
13
14
14
The license tells you what rights you have that are provided by the copyright holder. It is important that the contributor fully understands what rights they are
@@ -26,7 +26,7 @@ Getting Started
26
26
1. You will be asked to add one of the NSO Developer librarians as a collaborator, that person will then MOVE YOUR REPOSITORY to the [NSO Developer GitHub](https://github.com/NSO-developer).
27
27
[Read more about the implications here](https://help.github.com/enterprise/2.6/user/articles/about-repository-transfers/).
28
28
29
-
That’s it! When the move is done, your repository is now part of the NSO developer organization. Keep hacking on your project,
29
+
That’s it! When the move is done, your repository is now part of the NSO developer space. Keep hacking on your project,
30
30
you will still have owner privileges, and as such you can decide to give others write access for example.
31
31
32
32
Users of your repository can use Issues to report bugs and suggest new features, and Pull Requests to contribute code.
@@ -47,7 +47,7 @@ When using packages from the library you can expect:
47
47
* Do not include explicit references to customers (be it customer names, network configuration / templates, or otherwise)
48
48
49
49
## Requirements on your project
50
-
Before your project can be accepted into the NSO Developer organization it needs to fulfill the following criteria.
50
+
Before your project can be accepted into the NSO Developer space it needs to fulfill the following criteria.
51
51
52
52
### Developer Certificate of Origin
53
53
When sharing on GitHub you must ensure that your pull request includes a Developer Certification of Origin (DCO).
@@ -103,14 +103,14 @@ Add a README.md. Your README must include:
103
103
* If your project contains any copies of code derived from open source you need to explicitly list which projects.
104
104
105
105
### It must be open
106
-
The whole point of the NSO Developer Organization is to share code to the NSO ecosystem, as such we don’t want to make it “private”. However, that means that anyone can access the NSO Developer repositories, which requires us to approve the open access and ensure that no private information is included.
106
+
The whole point of the NSO Developer space is to share code to the NSO ecosystem, as such we don’t want to make it “private”. However, that means that anyone can access the NSO Developer repositories, which requires us to approve the open access and ensure that no private information is included.
107
107
108
108
The information in the README.md file will be displayed on the Cisco NSO DevNet site.
109
109
110
110
### Recommendations
111
111
* Add test cases, and instructions on how to run them. Why not use Lux to automate your tests? NSO uses it!
112
112
113
-
* Packaging make one repository for every stand-alone project. But don’t make a lot of small repositories of things that actually belong together, it just makes the organization cluttered and it will be harder to find your project.
113
+
* Packaging make one repository for every stand-alone project. But don’t make a lot of small repositories of things that actually belong together, it just makes the space cluttered and it will be harder to find your project.
114
114
115
115
* Naming convention for YANG modules. For a demo or example the module name and namespace does not matter that much (you can use http://example.com/... as namespace). But if your project is a re-usable piece, then consider using the URL of the project the namespace (as in: https://github.com/NSO-developer/PACKAGE-NAME/MODULE-NAME)
0 commit comments