Skip to content

Commit 48c0f1b

Browse files
dishantlangayandishantlangayan
committed
Prepare repo for import and comply with SolaceLab projects.
1 parent 56c2244 commit 48c0f1b

File tree

3 files changed

+275
-1
lines changed

3 files changed

+275
-1
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
community-github@solace.com.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
126+
at [https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# How to contribute
2+
3+
We'd love for you to contribute and welcome your help. Here are some guidelines to follow:
4+
5+
- [Issues and Bugs](#issue)
6+
- [Submitting a fix](#submitting)
7+
- [Feature Requests](#features)
8+
- [Questions](#questions)
9+
10+
## <a name="issue"></a> Did you find a issue?
11+
12+
* **Ensure the bug was not already reported** by searching on GitHub under *Issues*
13+
14+
* If you're unable to find an open issue addressing the problem, open a new one
15+
16+
## <a name="submitting"></a> Did you write a patch that fixes a bug?
17+
18+
Open a new GitHub pull request with the patch following the steps outlined below. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
19+
20+
Before you submit your pull request consider the following guidelines:
21+
22+
* Search *Pull Requests* for an open or closed Pull Request
23+
that relates to your submission. You don't want to duplicate effort.
24+
25+
### Submitting a Pull Request
26+
27+
Please follow these steps for all pull requests. These steps are derived from the [GitHub flow](https://help.github.com/articles/github-flow/).
28+
29+
#### Step 1: Fork
30+
31+
Fork the current repository and clone your fork
32+
locally.
33+
34+
```sh
35+
git clone https://github.com/solacecommunity/<github-repo>
36+
```
37+
38+
#### Step 2: Branch
39+
40+
Make your changes on a new git branch in your fork of the repository.
41+
42+
```sh
43+
git checkout -b my-fix-branch master
44+
```
45+
46+
#### Step 3: Commit
47+
48+
Commit your changes using a descriptive commit message.
49+
50+
```sh
51+
git commit -a -m "Your Commit Message"
52+
```
53+
54+
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
55+
56+
#### Step 4: Rebase (if possible)
57+
58+
Assuming you have not yet pushed your branch to origin, use `git rebase` (not `git merge`) to synchronize your work with the main
59+
repository.
60+
61+
```sh
62+
$ git fetch upstream
63+
$ git rebase upstream/master
64+
```
65+
66+
If you have not set the upstream, do so as follows:
67+
68+
```sh
69+
$ git remote add upstream https://github.com/solacecommunity/<github-repo>
70+
```
71+
72+
If you have already pushed your fork, then do not rebase. Instead merge any changes from master that are not already part of your branch.
73+
74+
#### Step 5: Push
75+
76+
Push your branch to your fork in GitHub:
77+
78+
```sh
79+
git push origin my-fix-branch
80+
```
81+
82+
#### Step 6: Pull Request
83+
84+
In GitHub, send a pull request to `<github-repo>:master`.
85+
86+
When fixing an existing issue, use the [commit message keywords](https://help.github.com/articles/closing-issues-via-commit-messages/) to close the associated GitHub issue.
87+
88+
* If we suggest changes then:
89+
* Make the required updates.
90+
* Commit these changes to your branch (ex: my-fix-branch)
91+
92+
That's it! Thank you for your contribution!
93+
94+
## <a name="features"></a> **Do you have an ideas for a new feature or a change to an existing one?**
95+
96+
* Open a GitHub issue and label it as an *enhancement* and describe the new functionality.
97+
98+
## <a name="questions"></a> Do you have questions about the source code?
99+
100+
* Ask any question about the code or how to use Solace technologies in the [Solace community](https://solace.community).

‎README.md‎

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,28 @@ The Solace Cloud CLI
1111

1212

1313
<!-- toc -->
14+
* [Overview](#overview)
1415
* [Usage](#usage)
1516
* [Configuration](#configuration)
17+
* [Resources](#resources)
18+
* [Contributing](#contributing)
19+
* [Authors](#authors)
20+
* [License](#license)
1621
* [Commands](#commands)
1722
<!-- tocstop -->
23+
# Overview
24+
<!-- overview -->
25+
The Solace Cloud CLI is a command line interface that simplifies deployment and configuration automation when working with your Solace Cloud org and services.
26+
27+
Use it to:
28+
29+
* Create and manage Environments
30+
* Create and manage Mission Control and Event Broker Services
31+
* Script deployment of Solace Cloud resources in your org
32+
33+
The CLI is built using the [oclif framework](https://oclif.io) that allows for plugin based development where users can add and extend the functionality of this CLI. For example, a new command can be added that can create and manage VPN Bridges, which uses the SEMP API to provision the bridges across two Message VPN on the same broker or across two brokers.
34+
35+
<!-- overviewstop -->
1836
# Usage
1937
<!-- usage -->
2038
```sh-session
@@ -42,7 +60,31 @@ The following Environment variables are optional:
4260
* SC_API_VERSION - The API version of the Solace Cloud REST API. Default is `v2`.
4361
* SC_BASE_URL - The location of your Solace Home Cloud account determines the base URL you use. Default is `https://api.solace.cloud/`
4462

45-
<!-- configurationtop -->
63+
<!-- configurationstop -->
64+
# Resources
65+
<!-- resources -->
66+
This is not an officially supported Solace product.
67+
68+
For more information try these resources:
69+
- Ask the [Solace Community](https://solace.community)
70+
- The Solace Developer Portal website at: https://solace.dev
71+
72+
<!-- resourcesstop -->
73+
# Contributing
74+
<!-- contributing -->
75+
Contributions are encouraged! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
76+
77+
<!-- contributingstop -->
78+
# Authors
79+
<!-- authors -->
80+
See the list of [contributors](https://github.com/solacelabs/solace-cloud-cli/graphs/contributors) who participated in this project.
81+
82+
<!-- authorsstop -->
83+
# License
84+
<!-- license -->
85+
See the [LICENSE](LICENSE) file for details.
86+
87+
<!-- licensestop -->
4688
# Commands
4789
<!-- commands -->
4890
* [`sc help [COMMAND]`](#sc-help-command)

0 commit comments

Comments
 (0)