From 2ef6fdf10f8a185845801f531e27a2b4173c6293 Mon Sep 17 00:00:00 2001 From: BushraNazish Date: Sat, 2 Apr 2022 11:07:51 +0530 Subject: [PATCH 1/2] README file updated --- README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c9f487f..c14c68c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,56 @@ # tweets -Repo for automating kubesimplify Tweets +### Repo for automating kubesimplify Tweets + +- Welcome to the **tweets** repo for KUBESIMPLIFY +- We are targeting to automate the tweets for KUBESIMPLIFY + +In this guide I will show you step by step how you can contribute here. + +### Steps Involved +- You need a github account and you need to fork this [repository](https://github.com/kubesimplify/tweets.git). + +- After your have forked the repo you will see `/tweets` under your account. + +- Now you need to clone the repo into your local system. For that open the terminal and clone. +``` +git clone https://github.com//tweets +``` +- then you need to go inside the directory +```cd tweets ``` +- You need to set upstream url, run this command to do so: +``` + +git remote add upstream https://github.com/kubesimplify/tweets.git +``` +> For learning more about upstream or origin and github, Watch [Kunal Kushwaha's](https://www.youtube.com/watch?v=apGV9Kg7ics) or [freecodecamp](https://www.youtube.com/watch?v=RGOj5yH7evk) course on github. +- Run these commands to add a different branch: + - You can have anything as , but by convention it should indicate what you are working on + -example : can be **add-folder**, when you are adding your folder. +``` +git branch + +git checkout +``` +* NOTE : Always try to make separate branches for each task and make PRs using those branches. Keeping the main of your fork clean, is always a good idea. +- Make a directory with an appropriate name +```mkdir ``` + - For adding spaces between the name, type as mkdir firstName-secondName . + -example : mkdir Blog-tweets +- To change directory into the folder, run ```cd +- Add a README.md file , to add your tweets accordingly. +- To push your changes to github, Run the following commands. +``` +git add . + +git commit -m " has a README file added" + +git push origin +``` +- Go to your github forked repo, You will see an option to "Compare and Pull request". +- Click on that and Then You will see an option to "Create pull request". Click on that. +- That's it you have made your pull request. +- After your request is accepted, You will see the folder of the directory name on the repository. +- We are waiting for your pull request. +- You can always have discussions regarding posting tweets on the [Discord Channel](https://saiyampathak.com/discord) + + From 34d0018c6d4cd745d8666fb7dfe0bd232edc5554 Mon Sep 17 00:00:00 2001 From: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> Date: Sun, 24 Apr 2022 14:58:08 +0530 Subject: [PATCH 2/2] Updated the Readme Added workflow diagram Added the Contribution List Overall improvement --- README.md | 123 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 121 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c9f487f..98a534f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,121 @@ -# tweets -Repo for automating kubesimplify Tweets +# KubeSimplify Tweets +Repo for automating kubeSimplify Tweets + +[![Parse issue and create PR](https://github.com/kubesimplify/tweets/actions/workflows/main.yml/badge.svg)](https://github.com/kubesimplify/tweets/actions/workflows/main.yml) +[![Twitter, together!](https://github.com/kubesimplify/tweets/actions/workflows/twitter-together.yml/badge.svg)](https://github.com/kubesimplify/tweets/actions/workflows/twitter-together.yml) + +Welcome🙏🏼 to the **tweets** repo of KUBESIMPLIFY. + +We are targeting to automate the tweets of KUBESIMPLIFY + +# Steps to post a tweet + +WorkFlow diagram + +```mermaid +flowchart LR; + classDef green color:#022e1f,fill:#00f500; + classDef red color:#022e1f,fill:#f11111; + classDef white color:#022e1f,fill:#fff; + classDef black color:#fff,fill:#000; + XX[Issue Created]:::white--Github Actions-->sss{PR created}:::black; + sss{PR created}--Approved-->tweeted[Tweet]:::green; + sss{PR created}--Disapproved-->CLOSED:::red; +``` + +# Contributing / Documentation + +## Example + +Create a new file `tweets/hello-world.tweet` with the content + +> Hello, world! + +You can use subfolders, e.g. `tweets/2019-02/hello-world.tweet`, as long as the file is in the `tweets/` folder and has a file with this file extension `.tweet` + +## Create a tweet with a twitter poll + +A tweet including a poll must end with 2-4 options in the following format +``` +Here is some text + +( ) option A +( ) option B +( ) option C +( ) option D +``` +## Notes + +- Only newly created files are handled, whereas deletions, updates or renames are ignored. +- ***.tweet** files will not be created for tweets you send 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`](https://help.github.com/en/articles/renaming-a-file-using-the-command-line), otherwise it may occur as deleted and added which would trigger a new tweet. +- your message must fit into a single tweet + +# Questions? + +If you have any further questions or suggestions, please create an issue at https://github.com/gr2m/twitter-together/issues/new + +# Step by Step Guide, How you can contribute here. + +### Steps Involved + +1. Fork this repo + if successful, will be redirected to your github account +2. Open Terminal to clone from your github repo +```bash +git clone https://github.com//tweets +``` + +3. then you need to go inside the directory +```bash +cd tweets/ +``` +4. You need to set upstream url, run this command to do so: +```bash +git remote add upstream https://github.com/kubesimplify/tweets.git +# as best practice before creating a new branch +git pull upstream main --rebase +``` + +5. Run these commands to add a different branch: + +You can have anything as , but by convention it should indicate what you are working on + +example : can be **add-folder**, when you are adding your folder. + +```bash +# next is to create a branch +git branch +git checkout +``` + +For learning more about upstream or origin and github, Watch [Kunal Kushwaha's](https://www.youtube.com/watch?v=apGV9Kg7ics) or [freecodecamp](https://www.youtube.com/watch?v=RGOj5yH7evk) course on github. + + + +⚠️**NOTE** : Always try to make separate branches for each task and make PRs using those branches. Keeping the main of your fork clean, is always a good idea. + +- Make a directory with an appropriate name + +```bash +mkdir +``` + +# Steps to create a PR +``` +git add . +git commit -m +git push origin # this will push your changes to your github repo +``` + +- Go to your github forked repo, You will see an option to **"Compare and Pull request"**. +- Click on that and Then You will see an option to **"Create pull request"**. Click on that. +- That's it you have made your pull request.🥳 +- After your request is accepted, You will see the folder of the directory name on the repository. +- We are waiting for your pull request. +- You can always have discussions regarding posting tweets on the [Discord Channel](https://saiyampathak.com/discord) + + + + +Made with [contributors-img](https://contrib.rocks). \ No newline at end of file