gistfile1.txt

# Kubeflow Twitter Guidelines

This repository is part of the automation, to tweet from the [kubeflow](https://twitter.com/kubeflow) twitter account. If you are looking at posting a tweet from the Kubeflow account, please follow the [instructions](#posting-a-new-tweet) below.

## Content Guidelines

We encourage participation and submissions from the community with the Kubeflow twitter account, however there are some guidelines to ensure that the account is managed in a manner appropriate for the project: 

- Tweets should not be vendor pitches
  - Submissions must contain content that applies broadly to the Kubeflow Community, for example a submission should focus on upstream Kubeflow as opposed to vendor-specific configurations.
  - Links should primarily be to the official Kubeflow documentation and other project properties. When using external references, links should be diverse.
- Tweets are not published on specific dates
  - Articles are reviewed by community volunteers. We'll try our best to accommodate specific timing, but we make no guarantees.
  - Releases get busy, if your submission is not time-sensitive consider submitting during a quieter period of the release cycle.
- Tweets should be relevant to Kubeflow users
  - Topics related to participation in or results of working group activities are always on topic.
  - Kubeflow components are purposely modular, so tools that use existing integration points are on topic.

## Automation

The automation is based on [twitter-together](https://github.com/gr2m/twitter-together) project.

> twitter-together is a GitHub Action that utilizes text files to publish tweets from a GitHub repository. Rather than tweeting directly, GitHub’s pull request review process encourages more collaboration, Twitter activity and editorial contributions by enabling everyone to submit tweet drafts to a project

Everytime a PR with a new `.tweet` file gets merged, the contents of the file will used to send out a tweet **instantly** from the Kubeflow account.

The automation also supports tweet scheduling with the help of [merge-schedule-action](https://github.com/gr2m/merge-schedule-action). To schedule a tweet for a specific day, enter the command `\schedule yyyy-mm-dd` in the PR description. This will tweet on the given day at 12 AM GMT. 

Note: The schedule feature is not supported for PR from fork repos. Therefore, this feature should be investigated further and should be used with caution

Thanks to the team behind **twitter-together** for putting together a wonderful open-source project.

## Posting a new tweet

1. Fork this repository
2. Create a new `.tweet` file with the tweet contents. Make sure the file is as per the guidelines outlined below. 
3. Create a PR to this repository
4. Once the PR is approved and merged, the tweet is sent out from the [Kubeflow account](https://twitter.com/kubeflow)

## Notes

- Only newly created files are handled, deletions, updates or renames are ignored.
- *.tweet files will not be created for tweets sent out directly from twitter.com
- If you need to rename an existing tweet file, please do so locally using git mv old_filename new_filename, otherwise it may occur as deleted and added which would trigger a new tweet.

## Contribute

We are always looking for people to help us improve the automation. Look at our [contributing guide](CONTRIBUTING.md) to get started.

For adding features to the Github actions, we encourage to make upstream contributions to the [twitter-together](https://github.com/gr2m/twitter-together) project and then use the new feature downstream here. 

## Guidelines

### File Name
- Make sure the `.tweet` file name created follows the convention `dd-mm-yyyy-<tweet-type>.tweet`

### File Contents
- Make sure the number of characters are under a tweet limit. You can add emojis to the text as well
- While doing the '@' mention, please make sure the username is correct