From aebd1ab71a36f1775f51b897ab80c3129a252e7c Mon Sep 17 00:00:00 2001 From: colin-mckibben-sp Date: Tue, 25 Oct 2022 15:21:55 -0400 Subject: [PATCH] Added contribution guideline and code of conduct --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 94 +++++++++++++++++++++++++++++++++ Makefile | 2 +- README.md | 10 ++++ 4 files changed, 233 insertions(+), 1 deletion(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..b4b9952 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +https://developer.sailpoint.com/discuss/c/feedback/. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0e29032 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,94 @@ +# Contributing to the SailPoint CLI + +We love your input! We want to make contributing to this project as easy and +transparent as possible. Look below if you would like to: + +- [Report an issue](#reporting-issues) +- [Make a feature request](#making-feature-requests) +- [Submit a fix](#submitting-a-fix) +- [Submit a new feature](#submitting-a-new-feature) +- [Submit a general issue or ask a question](#discussing-general-issues-or-questions) + +# High-level Guidelines + +## We Develop with GitHub + +We use GitHub to host code, track issues and feature requests, and +accept pull requests. + +## We Use GitHub Flow + +Pull requests are the best way to propose changes to the codebase, and +[Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow) is our preferred method of accepting pull requests. +The basics of GitHub flow are as follows: + +1. Fork the repo and create your branch from `main`. +2. Make your changes. +3. Issue your pull request! + +## We Use the MIT Software License + +In short, when you submit code changes, your submissions are understood to be +under the same [MIT License](http://choosealicense.com/licenses/mit/) that +covers the project. + +# Reporting Issues + +We use GitHub issues to track bugs publicly. If you see an issue with the site, please [report it here](https://github.com/sailpoint-oss/sailpoint-cli/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here); + +Our maintainers _love_ thorough bug reports. **Great bug reports** tend to have: + +- A quick summary and/or description +- CLI version +- Steps to reproduce + - Be specific! + - Give sample code if you can. +- What you expected would happen +- What actually happens +- Screenshots! +- Operating System +- Notes (possibly including why you think this might be happening, or stuff you + tried that didn't work) + +# Making Feature Requests + +We use GitHub issues to track feature requests. Please use [this template](https://github.com/sailpoint-oss/sailpoint-cli/issues/new?assignees=&labels=&template=feature-request.md&title=%5BFeature%5D+Your+Feature+Request+Here) when requesting a new feature. + +**Great feature requests** tend to: + +- Say if this is related to a problem (and describe said problem) +- Describe the solution you'd like +- Describe alternatives you use or have considered +- Notes (possibly including how you think this might benefit others) + +# Submitting a Fix + +Looking to fix something yourself? Great! Here are the steps to contribute a fix: + +- Fork the repository, copy the main branch only +- Pull down the code, build, and ensure it's running properly +- Create a new branch from main with the naming convention `fix/your-fix-name` +- Create a pull request from your branch to our origin repository's main branch! + +# Submitting a New Feature + +Looking to add a new feature yourself? Great! Here are the steps to contribute a feature: + +- Fork the repository, copy the main branch only +- Pull down the code, build, and ensure it's running properly +- Create a new branch from main with the naming convention + `feature/your-feature-name` +- Create a pull request from your branch to our origin repository's main branch! + +# Discussing General Issues or Questions + +If none of the above options work for you, you can submit a general issue using GitHub's +[issues](https://github.com/sailpoint-oss/sailpoint-cli/issues). You +can also head over to the +[Developer Community forum](https://developer.sailpoint.com/discuss) to discuss +with us directly on the forum about what you're thinking! + +# License + +By contributing, you agree that your contributions will be licensed under the +MIT License. diff --git a/Makefile b/Makefile index ce47ab6..f0593e6 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -VERSION = 0.0.2 +VERSION = 0.1.0 clean: go clean ./... diff --git a/README.md b/README.md index c46d1e8..01ad954 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ The SailPoint Command Line Interface (CLI) makes it easy to interact with SailPoint's SaaS Platform in a programmatic way. Many functions that use to be accomplished through tools like Postman or from custom scripts can now be done directly on the command line with minimal setup. +> :warning The SailPoint CLI is currently in pre-production and undergoing heavy development. Until the CLI reaches version 1.0.0, breaking changes may be introduced at any time while we work on refining the CLI. + # Install Installation of the CLI requires [Golang](https://go.dev/doc/install) version 1.17 or above. @@ -126,3 +128,11 @@ Run the `sail` command for an overview of the available commands and flags. You - [connectors](./cmd/connector/README.md) - [transforms](./cmd/transform/README.md) + +# Contributing + +Before you contribute you [must sign our CLA](https://cla-assistant.io/sailpoint-oss/sailpoint-cli). Please read our [contribution guidelines](https://github.com/sailpoint-oss/sailpoint-cli/blob/main/CONTRIBUTING.md) to learn how to contribute to this tool. + +# Code of Conduct + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. Read our [code of conduct](https://github.com/sailpoint-oss/sailpoint-cli/blob/main/CODE_OF_CONDUCT.md) to learn more.