Prep for 1.0.0 release

CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+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] - TBD
+
+## [1.0.0] - TBD
+### Added
+- Initial public release! 🎉
+- Support Post and Page post types by default, provide Custom Post Type (props @johnwatkins0 via #25)
+- REST API endpoint to replace AJAX callback (props @johnwatkins0 via #33)
+- Build process, PHPCS linting, unit tests, and Travis CI (props @johnwatkins0, @adamsilverstein via #23, #24, #28, #29)
+- Plugin banner and icon images (props @sncampbell via #31)
+
+### Changed
+- Refactor v0.1.0 significantly (props @adamsilverstein via #1)
+
+### Security
+- XSS prevention - switch from .innerHTML to text (props @adamsilverstein via #1)
+
+## [0.1.0] - 2018-05-11
+- Initial closed source release
+
+[Unreleased]: https://github.com/10up/autotweet/compare/master...develop
+[1.0.0]: https://github.com/10up/autotweet/compare/1020035...1.0.0
+[0.1.0]: https://github.com/10up/autotweet/commit/1020035f2d4843221d996bd5f8fe39d9ee850b5d

CODE_OF_CONDUCT.md

@@ -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 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. 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

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing and Maintaining
+
+First, thank you for taking the time to contribute!
+
+The following is a set of guidelines for contributors as well as information and instructions around our maintenance process. The two are closely tied together in terms of how we all work together and set expectations, so while you may not need to know everything in here to submit an issue or pull request, it's best to keep them in the same document.
+
+## Ways to contribute
+
+Contributing isn't just writing code - it's anything that improves the project. All contributions for AutoTweet are managed right here on GitHub. Here are some ways you can help:
+
+### Reporting bugs
+
+If you're running into an issue with the plugin, please take a look through [existing issues](https://github.com/10up/autotweet/issues) and [open a new one](https://github.com/10up/autotweet/issues/new) if needed. If you're able, include steps to reproduce, environment information, and screenshots/screencasts as relevant.
+
+### Suggesting enhancements
+
+New features and enhancements are also managed via [issues](https://github.com/10up/autotweet/issues).
+
+### Pull requests
+
+Pull requests represent a proposed solution to a specified problem. They should always reference an issue that describes the problem and contains discussion about the problem itself. Discussion on pull requests should be limited to the pull request itself, i.e. code review.
+
+For more on how 10up writes and manages code, check out our [10up Engineering Best Practices](https://10up.github.io/Engineering-Best-Practices/).
+
+## Workflow
+
+The `develop` branch is the development branch which means it contains the next version to be released. `stable` contains the current latest release and `master` contains the corresponding stable development version. Always work on the `develop` branch and open up PRs against `develop`.
+
+## Release instructions
+
+1. Starting from `develop`, cut a release branch named `release/X.Y.Z` for your changes.
+2. Version bump: Bump the version number in `autotweet.php` if it does not already reflect the version being released.
+3. Changelog: Add/update the changelog in `CHANGELOG.md` and `readme.txt`
+4. Update the `.pot` file by running `npm run makepot`.
+5. Check to be sure any new files/paths that are unnecessary in the production version are included in `.github/action-release/rsync-filter.txt`.
+6. Merge: Make a non-fast-forward merge from your release branch to `develop`, then do the same for `develop` into `master`. `master` contains the stable development version.
+7. Push: Push your `master` branch to GitHub, e.g. `git push origin master`.
+8. [Wait for build](https://xkcd.com/303/): Head to the [Actions](https://github.com/10up/autotweet/actions) tab in the repo and wait for it to finish if it hasn't already. If it doesn't succeed, figure out why and start over.
+9. Check the build: Check out the `stable` branch and test for functionality locally.
+10. Git tag: Create the release as `X.Y.Z` on the `stable` branch in GitHub. It should now appear under [releases](https://github.com/10up/autotweet/releases) and in the WordPress admin as an update as well.
+11. Edit the [X.Y.Z milestone](https://github.com/10up/autotweet/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close `X.Y.Z` milestone.
+12. If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X+1.0.0`, `X.Y+1.0`, `X.Y.Z+1`, or `Future Release`

CREDITS.md

@@ -0,0 +1,19 @@
+The following acknowledges the Maintainers for this repository, those who have Contributed to this repository (via bug reports, code, design, ideas, project management, translation, testing, etc.), and any Libraries utilized.
+
+## Maintainers
+
+The following individuals are responsible for curating the list of issues, responding to pull requests, and ensuring regular releases happen.
+
+[Adam Silverstein (@adamsilverstein)](https://github.com/adamsilverstein)
+
+## Contributors
+
+Thank you to all the people who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc.
+
+[Adam Silverstein (@adamsilverstein)](https://github.com/adamsilverstein), [John Watkins (@johnwatkins0)](https://github.com/johnwatkins0), [Scott Lee (@scottlee)](https://github.com/scottlee), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Stephanie Campbell (@sncampbell)](https://github.com/sncampbell), [Ryan Welcher (@ryanwelcher)](https://github.com/ryanwelcher)
+
+## Libraries
+
+The following software libraries are utilized in this repository.
+
+[TwitterOAuth](https://twitteroauth.com/) by [Abraham Williams](https://github.com/abraham) and licensed [MIT](https://github.com/abraham/twitteroauth/blob/master/LICENSE.md).

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 10up Inc. (https://10up.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,34 @@
+# Auto Tweet
+
+> Automatically tweets a post title, URL, and optional description.
+
+[![Support Level](https://img.shields.io/badge/support-active-green.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/autotweet.svg)](https://github.com/10up/autotweet/releases/latest) ![WordPress tested up to version](https://img.shields.io/badge/WordPress-v4.9.8%20tested-success.svg) [![MIT License](https://img.shields.io/github/license/10up/autotweet.svg)](https://github.com/10up/autotweet/blob/develop/LICENSE.md)
+
+## Overview
+
+**NOTE:** Post types are automatically set to auto-tweet. Future versions of this plugin could allow this to be set manually.
+
+## Installation
+1. Upload the entire `/tenup-auto-tweet` directory to the `/wp-content/plugins/` directory.
+2. Activate the plugin
+3. Register post type support for types that should be allowed to auto tweet. `add_post_type_support( 'post', 'tenup-auto-tweet' );`
+
+## FAQs
+### Does this plugin work with Gutenberg?
+Nope, not yet.
+
+## Support Level
+
+**Active:** 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress.  Bug reports, feature requests, questions, and pull requests are welcome.
+
+## Changelog
+
+A complete listing of all notable changes to Eight Day Week are documented in [CHANGELOG.md](https://github.com/10up/autotweet/blob/develop/CHANGELOG.md).
+
+## Contributing
+
+Please read [CODE_OF_CONDUCT.md](https://github.com/10up/autotweet/blob/develop/CODE_OF_CONDUCT.md) for details on our code of conduct, [CONTRIBUTING.md](https://github.com/10up/autotweet/blob/develop/CONTRIBUTING.md) for details on the process for submitting pull requests to us, and [CREDITS.md](https://github.com/10up/autotweet/blob/develop/CREDITS.md) for a listing of maintainers, contributors, and libraries for Auto Tweet.
+
+## Like what you see?
+
+<a href="http://10up.com/contact/"><img src="https://10updotcom-wpengine.s3.amazonaws.com/uploads/2016/10/10up-Github-Banner.png" width="850" alt="Work with us at 10up"></a>

readme.txt

@@ -18,18 +18,24 @@ Automatically tweets a post title, URL, and optional description.
 Does this plugin work with Gutenberg?
 Nope, not yet.
 
-== TODOs ==
-- Reevaluate storing the Twitter credentials in the database OR do a environment check. There's potential for a local environment tweeting publicly if using a copy of the production database.
-- Allow for post types to opt into/out of the auto-tweeting.
-- Remove jQuery dependency
-- Gutenberg compatibility
-- Remove composer dependencies from the repo
+== Changelog ==
 
+= 1.0.0 =
+== Added ==
+* Initial public release! 🎉
+* Support Post and Page post types by default, provide Custom Post Type (props @johnwatkins0)
+* REST API endpoint to replace AJAX callback (props @johnwatkins0)
+* Build process, PHPCS linting, unit tests, and Travis CI (props @johnwatkins0, @adamsilverstein)
+* Plugin banner and icon images (props Stephanie Campbell)
 
-== Changelog ==
+== Changed ==
+* Refactor v0.1.0 significantly (props @adamsilverstein)
+
+== Security ==
+* XSS prevention - switch from .innerHTML to text (props @adamsilverstein)
 
 = 0.1.0 =
-* First release
+* Initial closed source release
 
 == Upgrade Notice ==
 

tenup-auto-tweet.php

@@ -1,11 +1,14 @@
 <?php
 /**
- * Plugin Name: 10up Auto Tweet
- * Description: Adds the ability to automatically publish a status update to Twitter.
- * Version:     0.1.0
- * Author:      10up
- * Author URI:  https://10up.com
- * License:     GPLv2 or later
+ * Plugin Name:       10up Auto Tweet
+ * Description:       Adds the ability to automatically publish a status update to Twitter.
+ * Version:           0.1.0
+ * Requires at least: 5.0
+ * Requires PHP:      7.0
+ * Author:            10up
+ * Author URI:        https://10up.com
+ * License:           MIT
+ * License URI:       https://opensource.org/licenses/MIT
  *
  * @package TenUp\Auto_Tweet
  */