Skip to content

Commit

Permalink
Merge pull request clarkio#67 from MichaelJolley/vNext
Browse files Browse the repository at this point in the history
V next
  • Loading branch information
Michael Jolley committed May 26, 2019
2 parents 5045793 + 51121d9 commit e29d860
Show file tree
Hide file tree
Showing 11 changed files with 351 additions and 67 deletions.
3 changes: 2 additions & 1 deletion .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@
"code",
"design",
"doc",
"test"
"test",
"maintenance"
]
},
{
Expand Down
13 changes: 12 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

---

## [0.2.0] - 2019-05-26

### Added

- Broadcaster can use `!theme sub` or `!theme !sub` to activate or deactivate sub only mode
- Follower Only & Subscriber Only are now also VS Code settings so you don't have to use chat commands
- If user sends a `!theme {theme name}` with an invalid theme name, the extension will whisper them to let
them know it's not a valid theme name


## [0.1.0] - 2019-05-16

### Added
Expand Down Expand Up @@ -72,7 +82,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Pre-release version to gather feedback from the community and help identify gaps.

[Unreleased]: https://github.com/michaeljolley/vscode-twitch-themer/compare/0.1.0...HEAD
[Unreleased]: https://github.com/michaeljolley/vscode-twitch-themer/compare/0.2.0...HEAD
[0.1.0]: https://github.com/michaeljolley/vscode-twitch-themer/compare/0.1.0...0.2.0
[0.1.0]: https://github.com/michaeljolley/vscode-twitch-themer/compare/0.0.6...0.1.0
[0.0.6]: https://github.com/michaeljolley/vscode-twitch-themer/compare/0.0.5...0.0.6
[0.0.5]: https://github.com/michaeljolley/vscode-twitch-themer/compare/0.0.4...0.0.5
Expand Down
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
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, 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 [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.

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 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
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing

We appreciate contributions of any kind and acknowledge them on our [README][readme]. By participating
in this project, you agree to abide by our [code of conduct](CODE_OF_CONDUCT.md).

### Any enhancements/bugs/etc you see?

Add an issue. We'll review it, add labels and reply within a few days.

### See an issue you'd like to work on?

Comment on the issue that you'd like to work on it
and we'll add the `claimed` label. If you see the `claimed` label already on the issue you
might want to ask the contributor if they'd like some help.

### Documentation/etc need updating?

Go right ahead! Just submit a pull request when you're done.


## Pull Requests

We love pull requests from everyone.

Fork, then clone the repo:

git clone git@github.com:your-username/vscode-twitch-themer.git

**All changes should be based from the `vNext` branch.**

Push to your fork and [submit a pull request](https://github.com/michaeljolley/vscode-twitch-themer/compare/) against the `vNext` branch.

At this point you're waiting on us. We like to at least comment on pull requests
within three days (and, typically, one day). We may suggest
some changes or improvements or alternatives.

Normally reviews & merging occur live on stream at [https://twitch.tv/themichaeljolley](https://twitch.tv/themichaeljolley).

Some things that will increase the chance that your pull request is accepted:

* Update [README][readme] with any needed changes
* Update [CHANGELOG](CHANGELOG.md) with any changes
* Write tests.
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

[readme]: README.md
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

A Visual Studio Code extension that listens to twitch chat and allows viewers to change the streamers VS Code theme by sending **!theme**

![](./resources/screenshot-example.gif)
![](./resources/screenshot-example.gif)

## Twitch Chat Commands

Expand All @@ -23,7 +23,7 @@ This will send the currently active theme to Twitch chat.

#### Receive a list of available theme names

This will send a list of installed VS Code themes to the requestor via whisper.
This will send a list of installed VS Code themes to the requestor via whisper.

```
!theme list
Expand Down Expand Up @@ -88,6 +88,17 @@ These commands will either activate or deactivate follower only mode.
```
`Note: Follower only mode will be turned off on extension activation/start up`

#### Subscriber Only mode

These commands will either activate or deactivate subscriber only mode.

```
!theme sub
!theme !sub
```
`Note: Subscriber only mode will be turned off on extension activation/start up`


## How to connect to Twitch

Expand All @@ -110,7 +121,9 @@ These commands will either activate or deactivate follower only mode.
See [CHANGELOG.md](CHANGELOG.md)


## Contributors
## Contributing

Want to contribute? Check out our [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing](CONTRIBUTING.md) docs. This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

Expand All @@ -119,5 +132,3 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<table><tr><td align="center"><a href="https://michaeljolley.com/"><img src="https://avatars2.githubusercontent.com/u/1228996?v=4" width="100px;" alt="Michael Jolley"/><br /><sub><b>Michael Jolley</b></sub></a><br /><a href="https://github.com/MichaelJolley/vscode-twitch-themer/commits?author=MichaelJolley" title="Code">💻</a> <a href="https://github.com/MichaelJolley/vscode-twitch-themer/commits?author=MichaelJolley" title="Documentation">📖</a> <a href="#design-MichaelJolley" title="Design">🎨</a> <a href="#ideas-MichaelJolley" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-MichaelJolley" title="Maintenance">🚧</a> <a href="https://github.com/MichaelJolley/vscode-twitch-themer/commits?author=MichaelJolley" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/PatPat1567"><img src="https://avatars0.githubusercontent.com/u/41209202?v=4" width="100px;" alt="PatPat1567"/><br /><sub><b>PatPat1567</b></sub></a><br /><a href="https://github.com/MichaelJolley/vscode-twitch-themer/commits?author=PatPat1567" title="Code">💻</a> <a href="#ideas-PatPat1567" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/MichaelJolley/vscode-twitch-themer/commits?author=PatPat1567" title="Documentation">📖</a></td><td align="center"><a href="https://c-j.tech"><img src="https://avatars0.githubusercontent.com/u/3969086?v=4" width="100px;" alt="Chris Jones"/><br /><sub><b>Chris Jones</b></sub></a><br /><a href="#ideas-cmjchrisjones" title="Ideas, Planning, & Feedback">🤔</a></td><td align="center"><a href="https://github.com/parithon"><img src="https://avatars3.githubusercontent.com/u/8602418?v=4" width="100px;" alt="Anthony Conrad"/><br /><sub><b>Anthony Conrad</b></sub></a><br /><a href="#ideas-parithon" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/MichaelJolley/vscode-twitch-themer/commits?author=parithon" title="Code">💻</a> <a href="#design-parithon" title="Design">🎨</a> <a href="https://github.com/MichaelJolley/vscode-twitch-themer/commits?author=parithon" title="Documentation">📖</a> <a href="https://github.com/MichaelJolley/vscode-twitch-themer/commits?author=parithon" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/mholloway24"><img src="https://avatars2.githubusercontent.com/u/40776983?v=4" width="100px;" alt="Mike Holloway"/><br /><sub><b>Mike Holloway</b></sub></a><br /><a href="#ideas-mholloway24" title="Ideas, Planning, & Feedback">🤔</a></td><td align="center"><a href="https://github.com/John-Kryspin"><img src="https://avatars2.githubusercontent.com/u/6597539?v=4" width="100px;" alt="John Kryspin"/><br /><sub><b>John Kryspin</b></sub></a><br /><a href="#ideas-John-Kryspin" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/MichaelJolley/vscode-twitch-themer/commits?author=John-Kryspin" title="Code">💻</a> <a href="https://github.com/MichaelJolley/vscode-twitch-themer/issues?q=author%3AJohn-Kryspin" title="Bug reports">🐛</a> <a href="https://github.com/MichaelJolley/vscode-twitch-themer/commits?author=John-Kryspin" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/majorthorn"><img src="https://avatars3.githubusercontent.com/u/10319786?v=4" width="100px;" alt="majorthorn"/><br /><sub><b>majorthorn</b></sub></a><br /><a href="https://github.com/MichaelJolley/vscode-twitch-themer/issues?q=author%3Amajorthorn" title="Bug reports">🐛</a></td></tr></table>

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
41 changes: 11 additions & 30 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 12 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,18 @@
],
"configuration": {
"title": "Twitch Themer",
"properties": {}
"properties": {
"twitchThemer.followerOnly": {
"type": "boolean",
"default": false,
"description": "Follow Only mode"
},
"twitchThemer.subscriberOnly": {
"type": "boolean",
"default": false,
"description": "Subscriber only mode"
}
}
}
},
"scripts": {
Expand Down
Loading

0 comments on commit e29d860

Please sign in to comment.