Daily tips repo
Opened this issue · 30 comments
Description
What about having a community-tips repo, where people can raise issues or a new json file (ideally daily), with a small tip they learned that day to share with the community
Benefits:
- Helps the community and sharing tips
- Helps each person with their GitHub activity and green square 🟩
Note: If a json file, then a GitHub action could update the README with each json file and avoids conflicts
Green squares 👉 🟩 ✅ 😁
Thank you @alrifay , I will update my description - I was going to tag you in the brackets where I wrote I know it is a circle .. @alrifay 😂
@eddiejaoude could we use markdown files for this? e.g. we could have a markdown file that would allow us to parse it like
n.b. I can't remember the syntax, but I believe this is how a lot of static site generators work........... something like this...
---
summary: I think EVERYONE should delete 5 lines of their code everyday to reduce bugs.
---
# Example bit of code WITH MARKDOWN SYNTAX HIGHLIGHTING *HOPEFULLY
```typescript
const steveTest = () => {
return true;
}More about this
winning
References
@eddiejaoude @alrifay clearly this markdown inside a markdown wasn't gonna work very well above, but with markdown, we could parse the "tip" as a summary then you could embed code and references and whatever and click through straight to that MD file (e.g. it would be more like a blog!)
@stemount You can add markdown inside <pre><code></code></pre> or three ~ instead of three ` or indent the code block with 4 spaces😁
Example 1:
<pre>
<code>
```typescript
const steveTest = () => {
return true;
}
```
</code>
</pre>Example 2:
~~~markdown
```typescript
const steveTest = () => {
return true;
}
```
~~~Result:
---
summary: I think EVERYONE should delete 5 lines of their code everyday to reduce bugs.
---
# Example bit of code WITH MARKDOWN SYNTAX HIGHLIGHTING *HOPEFULLY
```typescript
const steveTest = () => {
return true;
}
```
# More about this
winning
# References
* [BlahLink](https://whatever.com)
I think EVERYONE should stop being as lazy as I am blaming the markdown formatter ;) @alrifay
An update on this topic 😃. @AllanRegush started this development on EddieBot with tips about open source.
This idea can be iterated upon and moved to a different repo like @eddiejaoude suggested on the issue description. In EddieBot, I think we could add a fetch package, to make an HTTP request and get the tips data (JSON or Markdown format), but again this would change with our implementation decision.
In my opinion, I think we could evaluate how many tips and how frequent contributions this will have. My concern is that we overengineer these tips 😅, and the resulting code to make it work is harder for newcomers to reason about.
But please let me know your thoughts as well 👍.
Keeping it simple for contributors is important, finding that balance is always difficult - but we can make small tweaks and review, therefore if we feel it is getting to complex and no benefit, we can pivot.
I dont think we will know the right answer with trying different things, yes some might be more clear than others, I am all for discussing and trying some options 🤓
Stale issue message
Stalebot lets keep this for now 🤓
Stale issue message
This has been opened for quite a while. What does everyone think about the current state of this issue?
Maybe we could use GitHub Discussions on this repo, instead of a new repo (at least for starters). We have the Tips & tricks category so I'd say it fits very well in this topic (plus, we still get 🟩 😃).
We could use Discussions to get a feel of how this would work and it's something we can start using today, with markdown support 👍! The downsides IMO are:
- Harder to integrate with EddieBot to show some tips with the
^tipscommand - No PRs to improve existing tips
I think you are right @BOLT04 👍 . Discussions helps us to get moving forwards faster, then we can improve afterwards
What about a Twitter bot for this which automatically sends the tip of the day as twitter post? 🤔
hmm we could do multiple things with the data and link it to all sorts of fun bots and sites 😄 .. I think there was a similar idea in discord chat about this
@kcoder63 has built a twitter bot, and is open to tweaking it - can you share a link to the repo?
Repo of the bot I made?
Yes please @kcoder63 👍
[Repo] (https://github.com/kcoder63/Edbeepbot)
here's the link
I think there's still some discussion to be had on this stalebot :)
Can someone remove the no-issue-activity label, please? I guess this will be implemented in the future.
@eddiejaoude Any update on this? I love the idea!
We might build this into EddieBot and people can add a role to get random daily tips
We might build this into EddieBot and people can add a role to get random daily tips
nice.
We might build this into EddieBot and people can add a role to get random daily tips
Good idea!
We might build this into EddieBot and people can add a role to get random daily tips
best idea. you are really master in open source ideas and public learning
What is the current state of this? 🤔 If not this could be a section in linkfree like a blog sorta
Interesting idea for LinkFree, we did think about having a daily standup section to hold ourselves accountable and share what we are doing, we could also have a tips section on our profiles 👍
Connecting this to Eddie bot and with command /dailytip you get a random tip of one of the folks?