diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..ba7e420f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,97 @@ +# Contributing to Veilid +Before you get started, please review our [Code of Conduct](./CODE_OF_CONDUCT.md). We're here to make things better and we cannot do that by treating each other without respect. + + +## Code Contributions +To begin crafting code to contribution to the Veilid project, first set up a [development environment]. After cloning the project, check out a new local branch and name it in a way that describes the work being done. This is refered to as a topic branch. + +Some contributions might introduce changes that are incompatible with other existing nodes. In this case it is recommended to also set a [development network]. *NEED TO WRITE* + +Once you have added your new function or addressed a bug, test it locally to ensure it's working as expected. If needed, test your work in a development network with more than one node based on your code. Once you're satisfied your code works as intended and does not introduce negative results or new bugs, follow the merge requests section below to submit your work for maintainer review. + +We try to consider all merge requests fairly and with attention deserving to those willing to put in time and effort, but if you do not follow these rules, your contribution +will be closed. We strive to ensure that the code joining the main branch is written to a high standard. + + +### Code Contribution Do's & Don'ts: + +Keeping the following in mind gives your contribution the best chance of landing! + +#### Merge Requests + +* **Do** create a [topic branch] to work on instead of working directly on `main`. This helps to: + * Protect the process. + * Ensures users are aware of commits on the branch being considered for merge. + * Allows for a location for more commits to be offered without mingling with other contributor changes. + * Allows contributors to make progress while a PR is still being reviewed. +* **Do** follow the [50/72 rule] for Git commit messages. +* **Do** target your merge request to the **main branch**. +* **Do** specify a descriptive title to make searching for your merge request easier. +* **Do** list [verification steps] so your code is testable. +* **Do** [reference associated issues] in your merge request description. +* **Don't** leave your merge request description blank. +* **Don't** abandon your merge request. Being responsive helps us land your code faster. +* **Don't** submit unfinished code. + + + +## Contributions Without Writing Code +There are numerous ways you can contribute to the growth and success of the Veilid project without writing code: + + - [submit]() bugs as well as feature/enhancement requests. Letting us know you found a bug, have an idea for a new feature, or see a way we can enhance existing features is just as important and useful as writing the code related to those things. Send us detailed information about your issue or idea: + - Features/Enhancements: Describe your idea. If you're able to, sketch out a diagram or mock-up. + - Bugs: Please be sure to include the expected behavior, the observed behavior, and steps to reproduce the problem. Please be descriptive about the environment you've installed your node or application into. More information can be found [below](#bug-reports). + - [Help other users with open issues]. Sometimes all an issue needs is a little conversation to clear up a process or misunderstanding. Please keep the [Code of Conduct](./CODE_OF_CONDUCT.md) in mind. + - Help other contributors test recently submitted merge requests. By pulling down a merge request and testing it, you can help validate new code contributions for stability and quality. + - Report a security or privacy vulnerability. Please let us know if you find ways in which Veilid could handle security and/or privacy in a different or better way. Surely let us know if you find broken or otherwise flawed security and/or privacy functions. You can report these directly to security@veilid.org or by using the form found [on our site]() *NEED TO BUILD* + - Add or edit documentation. Documentation is a living and evolving library of knowledge. As such, care, feeding, and even pruning is needed from time to time. If you're a non-native english speaker, you can help by replacing any ambiguous idioms, metaphors, or unclear language that might make our documentation hard to understand. + + +#### Bug Fixes +* **Do** include reproduction steps in the form of verification steps. +* **Do** link to any corresponding [Issues] in the format of `See #1234` in your commit description. + +## Bug Reports + +Please report vulnerabilities in Veilid directly to security@veilid.org or by using the form found [on our site]() *NEED TO BUILD*. More information about our disclosure policy and Veilid Foundation's approach to coordinated disclosure can be found [on our site](). *NEED TO WRITE* + +When reporting Veilid issues: +* **Do** write a detailed description of your bug and use a descriptive title. +* **Do** include reproduction steps, stack traces, and anything that might help us fix your bug. +* **Don't** file duplicate reports. Search open issues for similar bugs before filing a new report. +* **Don't** attempt to report issues on a closed PR. New issues should be openned against the `main` branch. + +If you're looking for more guidance, talk to other Veilid contributors on the [Veilid Discord]. + +**Thank you** for taking the few moments to read this far! Together we will build something truely remarkable. + + + +This contributor guide is inspired by the contribution guidelines of the [Metasploit Framework](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md) project found on GitHub. + +[Code of Conduct]:https://docs.metasploit.com/docs/code-of-conduct.html +[Submit bugs and feature requests]:http://r-7.co/MSF-BUGv1 +[Help fellow users with open issues]:https://github.com/rapid7/metasploit-framework/issues +[help fellow committers test recently submitted merge requests]:https://github.com/rapid7/metasploit-framework/pulls +[Report a security vulnerability in Metasploit itself]:https://www.rapid7.com/disclosure.jsp +[development environment]:http://r-7.co/MSF-DEV +[proof-of-concept exploits]:https://www.exploit-db.com/search?verified=true&hasapp=true&nomsf=true +[Ruby style guide]:https://github.com/bbatsov/ruby-style-guide +[Rubocop]:https://rubygems.org/search?query=rubocop +[50/72 rule]:http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +[topic branch]:http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches +[draft PR]:https://help.github.com/en/articles/about-pull-requests#draft-pull-requests +[console output]:https://docs.github.com/en/free-pro-team@latest/github/writing-on-github/creating-and-highlighting-code-blocks#fenced-code-blocks +[verification steps]:https://docs.github.com/en/free-pro-team@latest/github/writing-on-github/basic-writing-and-formatting-syntax#task-lists +[reference associated issues]:https://github.com/blog/1506-closing-issues-via-pull-requests +[PR#9966]:https://github.com/rapid7/metasploit-framework/pull/9966 +[pre-commit hook]:https://github.com/rapid7/metasploit-framework/blob/master/tools/dev/pre-commit-hook.rb +[API]:https://rapid7.github.io/metasploit-framework/api +[module documentation]:https://docs.metasploit.com/docs/using-metasploit/basics/module-documentation.html +[scripts]:https://github.com/rapid7/metasploit-framework/tree/master/scripts +[RSpec]:http://rspec.info +[Better Specs]:http://www.betterspecs.org/ +[YARD]:http://yardoc.org +[Issues]:https://github.com/rapid7/metasploit-framework/issues +[Metasploit Slack]:https://www.metasploit.com/slack +[#metasploit on Freenode IRC]:http://webchat.freenode.net/?channels=%23metasploit&uio=d4 diff --git a/README.md b/README.md index ceee00dd..24c0c3ef 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) + # Veilid ## Introduction diff --git a/code_of_conduct.md b/code_of_conduct.md new file mode 100644 index 00000000..d33878e1 --- /dev/null +++ b/code_of_conduct.md @@ -0,0 +1,134 @@ + +# 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, caste, color, 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 +[INSERT CONTACT METHOD]. +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.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations +