mirror of
https://github.com/turbot/steampipe.git
synced 2025-12-19 18:12:43 -05:00
Add README.md, CONTRIBUTING.md and CODE_OF_CONDUCT.md (#26)
This commit is contained in:
74
CODE_OF_CONDUCT.md
Normal file
74
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,74 @@
|
||||
## Code of Conduct
|
||||
|
||||
### Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as members,
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
nationality, personal appearance, race, religion, or sexual identity and
|
||||
orientation.
|
||||
|
||||
### Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
### Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers 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, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
### Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
### Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at [help@turbot.com](mailto:help@turbot.com). All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
### Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
24
CONTRIBUTING.md
Normal file
24
CONTRIBUTING.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# Contributing to Steampipe
|
||||
|
||||
Because Open Source plays a major part in how we build our products,
|
||||
we see it as a matter of course to give the same effort back to our
|
||||
community by creating extensible and easy-to-use software.
|
||||
|
||||
We welcome contributions from the community and have created some
|
||||
resources to help you get started extending Steampipe:
|
||||
|
||||
## Steampipe Architecture
|
||||
|
||||
https://steampipe.io/docs/develop/architecture
|
||||
|
||||
## Plugin Development Guide
|
||||
|
||||
https://steampipe.io/docs/develop/writing-plugins
|
||||
|
||||
## Naming Standards
|
||||
|
||||
https://steampipe.io/docs/develop/standards
|
||||
|
||||
## Coding Standards
|
||||
|
||||
https://steampipe.io/docs/develop/coding-standards
|
||||
47
README.md
47
README.md
@@ -1,2 +1,45 @@
|
||||
# steampipe
|
||||
Steampipe command line interface (CLI)
|
||||
<p align="center">
|
||||
<a href="https://steampipe.io">
|
||||
<img src="https://steampipe.io/images/steampipe_logo_wordmark_color.svg" height="48">
|
||||
</a>
|
||||
<h2 align="center">
|
||||
The extensible SQL interface to your favorite cloud APIs.<br />
|
||||
</h2>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a aria-label="Steampipe version" href="https://steampipe.io/download">
|
||||
<img alt="" src="https://img.shields.io/static/v1?label=cli&message=v0.1.0&style=for-the-badge&labelColor=777777&color=F3F1F0">
|
||||
</a>
|
||||
|
||||
<a aria-label="License" href="LICENSE">
|
||||
<img alt="" src="https://img.shields.io/static/v1?label=license&message=MPL-2.0&style=for-the-badge&labelColor=777777&color=F3F1F0">
|
||||
</a>
|
||||
|
||||
<a aria-label="Join the community on GitHub" href="https://github.com/turbot/steampipe/discussions">
|
||||
<img alt="" src="https://img.shields.io/badge/Join%20the%20community-F3F1F0.svg?style=for-the-badge&logo=GitHub&labelColor=777777&logoWidth=20">
|
||||
</a>
|
||||
</p>
|
||||
<p align="center"> </p>
|
||||
|
||||
## Getting Started
|
||||
|
||||
Visit https://steampipe.io/downloads to download Steampipe.
|
||||
|
||||
## Documentation
|
||||
|
||||
Visit https://steampipe.io/docs for full documentation on everything Steampipe.
|
||||
|
||||
## Plugins
|
||||
|
||||
Looking for plugins? Checkout [The Steampipe Hub](https://hubs.teampipe.io/) to browse available plugins and schema docs.
|
||||
|
||||
## Community
|
||||
|
||||
The Steampipe community can be found on [GitHub Discussions](https://github.com/turbot/steampipe/discussions), where you can ask questions, voice ideas, and share your projects.
|
||||
|
||||
Our [Code of Conduct](https://github.com/turbot/steampipe/CODE_OF_CONDUCT.md) applies to all Steampipe community channels.
|
||||
|
||||
## Contributing
|
||||
|
||||
Please see our [CONTRIBUTING.md](/CONTRIBUTING.md)
|
||||
|
||||
Reference in New Issue
Block a user