-
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.
Add Cisco guidelines for contributing to open-source projects #16
- Loading branch information
Showing
7 changed files
with
167 additions
and
20 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 |
|---|---|---|
|
|
@@ -7,7 +7,3 @@ | |
| build | ||
| .build | ||
| DerivedData/ | ||
|
|
||
| # Documentation | ||
| docs | ||
|
|
||
This file was deleted.
Oops, something went wrong.
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 |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| # Contributor Covenant 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, sex characteristics, gender identity and expression, | ||
| level of experience, education, socio-economic status, 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 within all project spaces, and it also applies when | ||
| an individual is representing the project or its community in public spaces. | ||
| 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 [[email protected]][conduct-email]. 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. | ||
|
|
||
| [conduct-email]: mailto:[email protected] | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
| available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html> | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
|
|
||
| For answers to common questions about this code of conduct, see | ||
| <https://www.contributor-covenant.org/faq> |
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 |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # How to Contribute | ||
|
|
||
| Thanks for your interest in contributing to `oauth2-swift`! Here are a few general guidelines on contributing and | ||
| reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of | ||
| the contributors managing and developing this open source project. In return, they should reciprocate that respect in | ||
| addressing your issue, assessing changes, and helping you finalize your pull requests. In that spirit of mutual respect, | ||
| we endeavor to review incoming issues and pull requests within 10 days, and will close any lingering issues or pull | ||
| requests after 60 days of inactivity. | ||
|
|
||
| Please note that all of your interactions in the project are subject to our [Code of Conduct](CODE_OF_CONDUCT.md). This | ||
| includes creation of issues or pull requests, commenting on issues or pull requests, and extends to all interactions in | ||
| any real-time space e.g., Slack, Discord, etc. | ||
|
|
||
| ## Reporting Issues | ||
|
|
||
| Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through our | ||
| [issues list](https://github.com/slidoapp/oauth2-swift/issues). | ||
|
|
||
| When creating a new issue, please be sure to include a **title and clear description**, as much relevant information as | ||
| possible, and, if possible, a test case. | ||
|
|
||
| **If you discover a security bug, please do not report it through GitHub. Instead, please see security procedures in | ||
| [SECURITY.md](SECURITY.md) document.** | ||
|
|
||
| ## Sending Pull Requests | ||
|
|
||
| Before sending a new pull request, take a look at existing pull requests and issues to see if the proposed change or fix | ||
| has been discussed in the past, or if the change was already implemented but not yet released. | ||
|
|
||
| We expect new pull requests to include tests for any affected behavior, and, as we follow semantic versioning, we may | ||
| reserve breaking changes until the next major version release. | ||
|
|
||
| ## Other Ways to Contribute | ||
|
|
||
| We welcome anyone that wants to contribute to `oauth2-swift` to triage and reply to open issues to help troubleshoot | ||
| and fix existing bugs. Here is what you can do: | ||
|
|
||
| - Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section, | ||
| providing feedback to the issue's author on what might be missing. | ||
| - Review existing pull requests, and testing patches against real existing applications that use `oauth2-swift` library. | ||
| - Write a test, or add a missing test case to an existing test. | ||
|
|
||
| Thanks again for your interest on contributing to `oauth2-swift` project! | ||
|
|
||
| :heart: |
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 |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Security Policies and Procedures | ||
|
|
||
| This document outlines security procedures and general policies for the | ||
| `oauth2-swift` project. | ||
|
|
||
| - [Reporting a Bug](#reporting-a-bug) | ||
| - [Disclosure Policy](#disclosure-policy) | ||
| - [Comments on this Policy](#comments-on-this-policy) | ||
|
|
||
| ## Reporting a Bug | ||
|
|
||
| The Slido team and community take all security bugs in | ||
| `oauth2-swift` seriously. Thank you for improving the security of | ||
| `oauth2-swift`. We appreciate your efforts and responsible disclosure and | ||
| will make every effort to acknowledge your contributions. | ||
|
|
||
| Report security bugs by emailing [[email protected]][security-email]. | ||
|
|
||
| The lead maintainer will acknowledge your email within 48 hours, and will send a | ||
| more detailed response within 48 hours indicating the next steps in handling | ||
| your report. After the initial reply to your report, the security team will | ||
| endeavor to keep you informed of the progress towards a fix and full | ||
| announcement, and may ask for additional information or guidance. | ||
|
|
||
| ## Disclosure Policy | ||
|
|
||
| When the security team receives a security bug report, they will assign it to a | ||
| primary handler. This person will coordinate the fix and release process, | ||
| involving the following steps: | ||
|
|
||
| - Confirm the problem and determine the affected versions. | ||
| - Audit code to find any potential similar problems. | ||
| - Prepare fixes for all releases still under maintenance. These fixes will be | ||
| released as quickly as possible. | ||
|
|
||
| ## Comments on this Policy | ||
|
|
||
| If you have suggestions on how this process could be improved please submit a | ||
| pull request. | ||
|
|
||
| [security-email]: mailto:[email protected] |
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
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