Skip to content

Commit

Permalink
Transfer existing code
Browse files Browse the repository at this point in the history
  • Loading branch information
albertbori committed Aug 15, 2022
1 parent 20a9615 commit 9c9e8b6
Show file tree
Hide file tree
Showing 77 changed files with 6,421 additions and 309 deletions.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,5 @@ Please provide the version number where this issue was encountered.

## Checklist

<!-- TODO: Update the link below to point to your project's contributing guidelines -->
- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/oss-template/blob/main/CONTRIBUTING.md)
- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/vsm-ios/blob/main/CONTRIBUTING.md)
- [ ] I have verified this does not duplicate an existing issue
3 changes: 1 addition & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ Note that by _not_ including a description, you are asking reviewers to do extra

## Checklist

<!-- TODO: Update the link below to point to your project's contributing guidelines -->
- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/oss-template/blob/main/CONTRIBUTING.md)
- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/vsm-ios/blob/main/CONTRIBUTING.md)
- [ ] Existing issues have been referenced (where applicable)
- [ ] I have verified this change is not present in other open pull requests
- [ ] Functionality is documented
Expand Down
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.DS_Store
/.build
/Packages
/*.xcodeproj
xcuserdata/
DerivedData/
.swiftpm/
124 changes: 1 addition & 123 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,126 +3,4 @@
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### TBA

## [0.3.8] - 2022-08-15

### Added

- Recommended configuration for [renovate](https://github.com/renovatebot/renovate)
- Linting workflow for `renovate.json` config

### Changed

- Pinned v4 of [github-pages-deploy-action](https://github.com/marketplace/actions/deploy-to-github-pages)
- Removed [dependabot](https://github.com/dependabot) configuration

## [0.3.7] - 2022-04-04

### Changed

- Update lint workflow trigger behavior

## [0.3.6] - 2022-03-22

### Added

- Adds new template badges to README

### Changed

- Bumps [actions/checkout](https://github.com/marketplace/actions/checkout) from v2 to v3

## [0.3.5] - 2021-10-21

### Added

- Add step to update contact information in Code of Conduct

## [0.3.4] - 2021-10-19

### Added

- Dependabot configuration

## [0.3.3] - 2021-10-07

### Added

- Markdown linting

## [0.3.2] - 2021-08-24

### Added

- Version badge in README links to this changelog

## [0.3.1] - 2021-08-02

### Added

- This changelog

### Changed

- Add versioning badge to README
- Add step to remove contents of changelog to prevent confusion

## [0.3.0] - 2021-07-21

### Added

- Integrate stale action

### Changed

- Add "Before you begin" section to README

## [0.2.1] - 2021-06-08

### Changed

- Add explanation of why PR descriptions are so important

## [0.2.0] - 2021-06-03

### Added

- Pull request template
- Bug report template
- Feature request template

## [0.1.1] - 2021-05-24

### Changed

- Be more explicit about where the code of conduct applies

## [0.1.0] - 2021-05-11

### Added

- Contributor Covenant
- Contribution guidelines
- Maintainers file
- README template
- Security guidance

[unreleased]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.8...HEAD
[0.3.8]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.7...v0.3.8
[0.3.7]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.6...v0.3.7
[0.3.6]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.5...v0.3.6
[0.3.5]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.4...v0.3.5
[0.3.4]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.3...v0.3.4
[0.3.3]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.2...v0.3.3
[0.3.2]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.1...v0.3.2
[0.3.1]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.0...v0.3.1
[0.3.0]: https://github.com/wayfair-incubator/oss-template/compare/v0.2.1...v0.3.0
[0.2.1]: https://github.com/wayfair-incubator/oss-template/compare/v0.2.0...v0.2.1
[0.2.0]: https://github.com/wayfair-incubator/oss-template/compare/v0.1.1...v0.2.0
[0.1.1]: https://github.com/wayfair-incubator/oss-template/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/wayfair-incubator/oss-template/releases/tag/v0.1.0
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
142 changes: 41 additions & 101 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,132 +1,72 @@
# Contributor Covenant Code of Conduct

# 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 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.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards
**Our Standards**

Examples of behavior that contributes to a positive environment for our
community include:
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
- 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
- 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

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.
**Enforcement Responsibilities**

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
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.

## Enforcement Guidelines
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.

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
**Scope**

### 1. Correction
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.

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Enforcement**

**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.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at opensource@wayfair.com. All complaints will be reviewed and investigated promptly and fairly.

### 2. Warning
All community leaders are obligated to respect the privacy and security of the reporter of any incident.

**Community Impact**: A violation through a single incident or series
of actions.
**Enforcement Guidelines**

**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.
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 3. Temporary Ban
- **1. Correction**

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
_**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.

**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.
- **2. Warning**

### 4. Permanent Ban
_**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.

**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.
- **3. Temporary Ban**

**Consequence**: A permanent ban from any sort of public interaction within
the community.
_**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.

## Attribution
- **4. Permanent Ban**

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][v2.0].
_**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.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
**Attribution**

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].
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).

[homepage]: https://www.contributor-covenant.org
[v2.0]: https://www.contributor-covenant.org/version/2/0/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
Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder at [https://github.com/mozilla/diversity](https://github.com/mozilla/diversity).
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to Contribute

Thanks for your interest in contributing to `<project name>`! Here are a few general guidelines on contributing and
Thanks for your interest in contributing to `VSM for iOS`! 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,
Expand All @@ -14,7 +14,7 @@ any real-time space (eg. 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/org_name/repo_name/issues).
[issues list](https://github.com/wayfair-incubator/vsm-ios/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.
Expand All @@ -32,16 +32,16 @@ reserve breaking changes until the next major version release.

## Other Ways to Contribute

We welcome anyone that wants to contribute to `<project name>` to triage and reply to open issues to help troubleshoot
We welcome anyone that wants to contribute to `VSM for iOS` 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 and update the existing content of our [Wiki](https://github.com/org_name/repo_name/wiki) with up-to-date
- Review and update the existing content of our [Wiki](https://github.com/wayfair-incubator/vsm-ios/wiki) with up-to-date
instructions and code samples.
- Review existing pull requests, and testing patches against real existing applications that use `<project name>`.
- Review existing pull requests, and testing patches against real existing applications that use `VSM for iOS`.
- Write a test, or add a missing test case to an existing test.

Thanks again for your interest on contributing to `<project name>`!
Thanks again for your interest on contributing to `VSM for iOS`!

:heart:
Loading

0 comments on commit 9c9e8b6

Please sign in to comment.