Skip to content

Commit 100a03d

Browse files
mohammed786mohammed786
authored
Merging to Main from Develop for 0.2.0 release (#13)
0.2.0
1 parent cbae9ad commit 100a03d

43 files changed

Lines changed: 1804 additions & 184 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: mohammed786
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Additional context**
32+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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+
.
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.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Contributing to LoginRadius CLI
2+
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4+
5+
The following is a set of guidelines for contributing to LoginRadius CLI, which is hosted in the [LoginRadius Organization](https://github.com/loginradius) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
6+
7+
## Code of Conduct
8+
9+
This project and everyone participating in it are governed by the [LoginRadius Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behaviour to [support@loginradius.com](mailto:support@loginradius.com).
10+
11+
## I don't want to read this whole thing I just have a question!!!
12+
13+
> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below.
14+
15+
* [Discuss on Community Page](https://community.loginradius.com/)
16+
* [Ask On StackOverflow](https://stackoverflow.com/questions/ask/?tags=loginradius)
17+
18+
## How Can I Contribute?
19+
20+
### Reporting Bugs
21+
22+
* **Do not open up a GitHub issue if the bug is a security vulnerability
23+
in LoginRadius CLI**, and instead to refer to our [security policy](https://www.loginradius.com/security-policy).
24+
25+
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/loginradius/lr-cli/issues).
26+
27+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/loginradius/lr-cli/issues/new) and provide the following information by filling in [the template](https://github.com/loginradius/lr-cli/.github/blob/master/.github/ISSUE_TEMPLATE/bug_report.md).
28+
29+
* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
30+
31+
#### Provide more context by answering these questions:
32+
33+
* **Did the problem start happening recently** (e.g. after updating to a new version of LoginRadius CLI) or was this always a problem?
34+
* If the problem started happening recently, **can you reproduce the problem in an older version of LoginRadius CLI?** What's the most recent version in which the problem doesn't happen? You can download older versions of LoginRadius CLI from [the releases page](https://github.com/loginradius/lr-cli/releases).
35+
* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
36+
37+
#### Did you write a patch that fixes a bug?
38+
39+
* Open a new GitHub pull request with the patch.
40+
41+
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
42+
43+
#### Did you fix whitespace, format code, or make a purely cosmetic patch?
44+
45+
Changes that are cosmetic and do not add anything substantial to the stability, functionality, or testability of LoginRadius CLI will generally not be accepted.
46+
47+
### Suggesting Enhancements
48+
49+
* Suggest your change in the [LoginRadius community page](https://community.loginradius.com/) and start writing code.
50+
51+
* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
52+
53+
### Your First Code Contribution
54+
55+
Unsure where to begin contributing to LoginRadius? You can start by looking through these `beginner` and `help-wanted` issues:
56+
57+
* [Beginner issues][beginner] - issues that should only require a few lines of code, and a test or two.
58+
* [Help wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues.
59+
60+
### Pull Requests
61+
62+
The process described here has several goals:
63+
64+
- Maintain LoginRadius's quality
65+
- Fix problems that are important to users
66+
- Engage the community in working toward the best possible authentication experience.
67+
- Enable a sustainable system for LoginRadius's maintainers to review contributions
68+
69+
Please follow these steps to have your contribution considered by the maintainers:
70+
71+
1. Follow all instructions in [the template](PULL_REQUEST_TEMPLATE.md)
72+
2. Follow the [styleguides](#styleguides)
73+
3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>
74+
75+
While the prerequisites above must be satisfied before having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
76+
77+
## Styleguides
78+
79+
### Git Commit Messages
80+
81+
* Use the present tense ("Add feature" not "Added feature")
82+
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
83+
* Limit the first line to 72 characters or less
84+
* Reference issues and pull requests liberally after the first line
85+
* When only changing documentation, include `[ci skip]` in the commit title
86+
* Consider starting the commit message with an applicable emoji:
87+
* :art: `:art:` when improving the format/structure of the code
88+
* :racehorse: `:racehorse:` when improving performance
89+
* :non-potable_water: `:non-potable_water:` when plugging memory leaks
90+
* :memo: `:memo:` when writing docs
91+
* :penguin: `:penguin:` when fixing something on Linux
92+
* :apple: `:apple:` when fixing something on macOS
93+
* :checkered_flag: `:checkered_flag:` when fixing something on Windows
94+
* :bug: `:bug:` when fixing a bug
95+
* :fire: `:fire:` when removing code or files
96+
* :green_heart: `:green_heart:` when fixing the CI build
97+
* :white_check_mark: `:white_check_mark:` when adding tests
98+
* :lock: `:lock:` when dealing with security
99+
* :arrow_up: `:arrow_up:` when upgrading dependencies
100+
* :arrow_down: `:arrow_down:` when downgrading dependencies
101+
* :shirt: `:shirt:` when removing linter warnings
102+
103+
Thanks! :heart: :heart: :heart:
104+
105+
LoginRadius Team
106+
107+
108+
109+
110+

‎PULL_REQUEST_TEMPLATE.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<!--
2+
Thank you for your pull request. Please review the below requirements.
3+
-->
4+
5+
#### Checklist
6+
7+
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
8+
9+
#### Please note that in case of below checklist not updated accordingly, the maintainers have the right to immediately close your pull request.
10+
11+
- [ ] You created a branch from `develop` branch.
12+
- [ ] You PR is raised on `develop` branch and not on`main`.
13+
- [ ] You have read the [Contribution Guidlines](CONTRIBUTING.md) before creating this PR.
14+
15+
### Description of the Change
16+
17+
<!--
18+
19+
We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
20+
21+
-->
22+
23+
### Alternate Designs
24+
25+
<!-- Explain what other alternates were considered and why the proposed version was selected -->
26+
27+
### Risk Impact
28+
29+
<!-- What are the possible side-effects or negative impacts of the code change? -->
30+
31+
### Verification Process
32+
33+
<!--
34+
35+
What process did you follow to verify that the change has not introduced any regressions? Describe the actions you performed (including buttons you clicked, text you typed, commands you ran, etc.), and describe the results you observed.
36+
37+
-->
38+
39+
### Release Notes
40+
41+
<!--
42+
43+
Please describe the changes in a single line that explains this improvement in terms that a user can understand. This text will be used in LoginRadius CLI's release notes.
44+
45+
If this change is not user-facing or notable enough to be included in release notes
46+
you may use the strings "Not applicable" or "N/A" here.
47+
48+
Examples:
49+
50+
- Added Test Cases for the Login Command
51+
- Increased the performance for a Social Configuration command
52+
53+
-->

‎README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@
1212

1313
`lr` is available via [Homebrew](https://brew.sh/) and as a downloadable binary from the [release page](https://github.com/loginradius/lr-cli/releases/latest).
1414

15+
### How do I install this formulae using homebrew?
16+
17+
#### Install the tap via:
18+
19+
```sh
20+
$ brew tap loginradius/tap
21+
```
22+
#### Then you can install LR CLI via:
23+
24+
```sh
25+
$ brew install lr
26+
```
27+
1528
## Other Platforms
1629

1730
Download packaged binaries from the [release page](https://github.com/loginradius/lr-cli/releases/latest).
@@ -53,6 +66,13 @@ Download packaged binaries from the [release page](https://github.com/loginradiu
5366
#### Windows
5467
Run `bin\lr --help` to check if it worked.
5568

69+
## Contributing
70+
71+
We encourage you to contribute to LoginRadius CLI! Please check out the
72+
[Guidelines for Contributing](CONTRIBUTING.md) and become a contributor.
73+
74+
Everyone interacting in LoginRadius CLI codebases, issue trackers, chat rooms, and mailing lists is expected to follow the LoginRadius [code of conduct](CODE_OF_CONDUCT.md).
75+
5676
## License
5777

5878
For more information on licensing, please refer to [License](https://github.com/LoginRadius/lr-cli/blob/master/LICENSE)

0 commit comments

Comments
 (0)