DEV Community

Cover image for If you run a Github organisation you must do this now!
Aniket Pal
Aniket Pal

Posted on

If you run a Github organisation you must do this now!

Looking to have your Github organisation standout? Wanting it to match all the beautiful and intricate design work that your organisation has developed? Don't want to add contributing guidelines and code of conduct to every project? Don't worry this blog got you covered!

In this blog, I will walk you through how to update your GitHub organisation, add more personalisation, and help your organisation stand out from the crowd. Incase you don't know markdown refer this

Creating the special repository 😎

In order to customize your Github organisation first let's initialise repo in which we will work!

Github organisation readme repository name

Create a new repository with the name .github and make sure to keep the repo public and initialise with a readme.

Github organisation readme public init

Creating the profile πŸ”₯

Create a directory with the name profile and initialise with a markdown file named README.md or click on the green button in the repo which says Add profile README

Github organisation readme profile init

Once the file has been created, you will see that GitHub knows you have accessed this special repo and presents you with the option to edit the file. Go ahead and click on this. You will get directed over to the file editor that is built into GitHub. Incase you have never created a readme make sure to visit this

Github organisation profile readme init

Let's add COC and CG πŸš€

In general all the projects in a particular organisation follows the same code of conduct, contributing guidelines and security rules and it becomes difficult to add it in every project. Now you can add it in the .github repo and make sure every contributor reads before sending a pull request! Incase you are confused on how it should look finally refer to this

Screenshot 2021-09-16 at 11.57.13 AM

Conclusion πŸ’•

Making sure that your org stand out from the rest is crucial. Take advantage of the ability to personalise your organisation to showcase your community guidelines.

Have you already added the readme? I’d love to take a look at it! Feel free to share it with me. Would also love to collaborate on github

Discussion (17)

Collapse
siddharthshyniben profile image
Siddharth

Nice feature!

I'm guessing this only landed recently? Because I've never seen this anywhere before.

Collapse
aniket762 profile image
Aniket Pal Author

Yes! They launched it recently!

Collapse
sanjeetcrypto profile image
sanjeet patro

It is a great read😍

Collapse
asambhab profile image
a-sambhab

Thank you

Collapse
aniket762 profile image
Aniket Pal Author

Glad you liked it ! πŸ”₯

Collapse
shreyakhetan765 profile image
Shreya Khetan

Very helpful indeed!

I would have missed this if I had not landed on this post. This post should surely be hyped up for everyone to know about the same.

Thank you very much for the information.
Great content, keep it up buddy!

Collapse
aniket762 profile image
Aniket Pal Author

Collapse
rammcodes profile image
Ram Maheshwari πŸ’š

This is very helpful, Aniket. Thanks for sharing it.

Collapse
aniket762 profile image
Aniket Pal Author

Thanks a lot @rammcodes πŸ’• You inspired me to write blogs!

Collapse
thomasbnt profile image
Thomas Bnt

This is AWESOME !

Collapse
aniket762 profile image
Aniket Pal Author

Thanks @thomasbnt means a lot!

Collapse
kumarshantanu01 profile image
Kumar Shantanu

Awesome!

Collapse
aniket762 profile image
Aniket Pal Author

Thanks a lot!

Collapse
sumana2001 profile image
Sumana Basu

Wow! What a cool feature😍 Will use this for sure

Collapse
aniket762 profile image
Aniket Pal Author

Thanks a lot @sumana2001

Collapse
asambhab profile image
a-sambhab

Very good stuff🌚

Collapse
aniket762 profile image
Aniket Pal Author

Means a lot πŸ€“