forked from kubescape/kubescape
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial documentation update upon joining the CNCF (kubescape#1020)
* Initial refactor Signed-off-by: Craig Box <[email protected]> * Initial refactor. Signed-off-by: Craig Box <[email protected]> * Now how did that get in there? Signed-off-by: Craig Box <[email protected]> * small fixes Signed-off-by: Craig Box <[email protected]> * Use GitHub note and warning syntax Signed-off-by: Craig Box <[email protected]> * second guessing thing with no docs Signed-off-by: Craig Box <[email protected]> * Final changes Signed-off-by: Craig Box <[email protected]> Signed-off-by: Craig Box <[email protected]>
- Loading branch information
Showing
30 changed files
with
530 additions
and
554 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,14 +4,16 @@ First, it is awesome that you are considering contributing to Kubescape! Contrib | |
|
|
||
| When contributing, we categorize contributions into two: | ||
| * Small code changes or fixes, whose scope is limited to a single or two files | ||
| * Complex features and improvements, that are not limited | ||
| * Complex features and improvements, with potentially unlimited scope | ||
|
|
||
| If you have a small change, feel free to fire up a Pull Request. | ||
|
|
||
| When planning a bigger change, please first discuss the change you wish to make via issue, | ||
| email, or any other method with the owners of this repository before making a change. Most likely your changes or features are great, but sometimes we might be already going in this direction (or the exact opposite ;-) ) and we don't want to waste your time. | ||
| When planning a bigger change, please first discuss the change you wish to make via an issue, | ||
| so the maintainers are able to help guide you and let you know if you are going in the right direction. | ||
|
|
||
| Please note we have a code of conduct, please follow it in all your interactions with the project. | ||
| ## Code of Conduct | ||
|
|
||
| Please follow our [code of conduct](CODE_OF_CONDUCT.md) in all of your interactions within the project. | ||
|
|
||
| ## Pull Request Process | ||
|
|
||
|
|
@@ -22,79 +24,41 @@ Please note we have a code of conduct, please follow it in all your interactions | |
| 3. Open Pull Request to `dev` branch - we test the component before merging into the `master` branch | ||
| 4. We will merge the Pull Request once you have the sign-off. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| ### Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to make 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: | ||
| ## Developer Certificate of Origin | ||
|
|
||
| * 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 | ||
| All commits to the project must be "signed off", which states that you agree to the terms of the [Developer Certificate of Origin](https://developercertificate.org/). This is done by adding a "Signed-off-by:" line in the commit message, with your name and email address. | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
| Commits made through the GitHub web application are automatically signed off. | ||
|
|
||
| * 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 | ||
| ### Configuring Git to sign off commits | ||
|
|
||
| We will distance those who constantly adhere to unacceptable behavior. | ||
| First, configure your name and email address in Git global settings: | ||
|
|
||
| ### Our Responsibilities | ||
| ``` | ||
| $ git config --global user.name "John Doe" | ||
| $ git config --global user.email [email protected] | ||
| ``` | ||
|
|
||
| Project maintainers are responsible for clarifying the standards of acceptable | ||
| behavior and are expected to take appropriate and fair corrective actions in | ||
| response to any instances of unacceptable behavior. | ||
| You can now sign off per-commit, or configure Git to always sign off commits per repository. | ||
|
|
||
| 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. | ||
| ### Sign off per-commit | ||
|
|
||
| ### Scope | ||
| Add [`-s`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s) to your Git command line. For example: | ||
|
|
||
| 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. | ||
| ```git commit -s -m "Fix issue 64738"``` | ||
|
|
||
| ### Enforcement | ||
| This is tedious, and if you forget, you'll have to [amend your commit](#f) | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting the project team at [INSERT EMAIL ADDRESS]. 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. | ||
| ### Configure a repository to always include sign off | ||
|
|
||
| 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. | ||
| There are many ways to achieve this with Git hooks, but the simplest is to do the following: | ||
|
|
||
| ### Attribution | ||
| ``` | ||
| cd your-repo | ||
| curl -Ls https://gist.githubusercontent.com/dixudx/7d7edea35b4d91e1a2a8fbf41d0954fa/raw/prepare-commit-msg -o .git/hooks/prepare-commit-msg | ||
| chmod +x .git/hooks/prepare-commit-msg | ||
| ``` | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
| available at [http://contributor-covenant.org/version/1/4][version] | ||
| ## Fixing a commit where the DCO failed | ||
|
|
||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/4/ | ||
| Check out [this guide](https://github.com/src-d/guide/blob/master/developer-community/fix-DCO.md). | ||
Oops, something went wrong.