DEV Community 👩‍💻👨‍💻

Kiran Akadas
Kiran Akadas

Posted on

My First Github Workflow

Greet and Stats!

My new github action follows a simple workflow: Whenever a user opens a pull request to the repository with the configured workflow, a comment is made on the PR with a greeting to the user and another comment with the statistics about the repository and PR are posted.
Used the github-scripts (https://github.com/actions/github-script) action to get the API and context to write my own script in the workflow.
It was a very fun exercise for me. Thankyou Dev Team for this cool contest!

Submission Category:

Maintainer Must-Haves

Yaml File or Link to Code

https://github.com/KiranAkadas/WebTechnologies_PasswordSecurity/blob/master/.github/workflows/new.yml

Additional Resources / Info

A sample of this can be found on this repo for any PR
https://github.com/KiranAkadas/WebTechnologies_PasswordSecurity

PS: I've started writing my own Github Action on my repository using JS, facing a few challenges and due to lack of docs, it's going slowly, but will publish it soon :)

Top comments (0)

Timeless DEV post...

How to write a kickass README

Arguably the single most important piece of documentation for any open source project is the README. A good README not only informs people what the project does and who it is for but also how they use and contribute to it.

If you write a README without sufficient explanation of what your project does or how people can use it then it pretty much defeats the purpose of being open source as other developers are less likely to engage with or contribute towards it.