Skip to content

Commit 150475d

Browse files
author
daloher
committed
Adding readme and license
0 parents  commit 150475d

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

Diff for: LICENSE

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright (c) 2016 Microsoft Inc
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.

Diff for: README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Software for Open Networking in the Cloud - SONiC
2+
# Management
3+
4+
### This software repository must be treated as private and is only shared under NDA terms with Microsoft until publicly released.
5+
6+
# Description
7+
Tools for managing, configuring and monitoring SONiC
8+
9+
10+
# Contribution guide
11+
12+
All contributors must sign a contribution license agreement before contributions can be accepted. Contact [email protected] or [email protected]. Later this will be automated.
13+
14+
### GitHub Workflow
15+
16+
We're following basic GitHub Flow. If you have no idea what we're talking about, check out [GitHub's official guide](https://guides.github.com/introduction/flow/). Note that merge is only performed by the repository maintainer.
17+
18+
Guide for performing commits:
19+
20+
* Isolate each commit to one component/bugfix/issue/feature
21+
* Use a standard commit message format:
22+
23+
> [component/folder touched]: Description intent of your changes
24+
>
25+
> [List of changes]
26+
>
27+
> Signed-off-by: Your Name [email protected]
28+
29+
For example:
30+
31+
> swss-common: Stabilize the ConsumerTable
32+
>
33+
> * Fixing autoreconf
34+
> * Fixing unit-tests by adding checkers and initialize the DB before start
35+
> * Adding the ability to select from multiple channels
36+
> * Health-Monitor - The idea of the patch is that if something went wrong with the notification channel,
37+
> we will have the option to know about it (Query the LLEN table length).
38+
>
39+
> Signed-off-by: [email protected]
40+
41+
42+
* Each developer should fork this repository and [add the team as a Contributor](https://help.github.com/articles/adding-collaborators-to-a-personal-repository)
43+
* Push your changes to your private fork and do "pull-request" to this repository
44+
* Use a pull request to do code review
45+
* Use issues to keep track of what is going on

0 commit comments

Comments
 (0)