This content originally appeared on DEV Community and was authored by Aniket Pal
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!
Create a new repository with the name .github and make sure to keep the repo public and initialise with a readme.
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
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
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
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
This content originally appeared on DEV Community and was authored by Aniket Pal
Aniket Pal | Sciencx (2021-09-16T06:48:09+00:00) If you run a Github organisation you must do this now!. Retrieved from https://www.scien.cx/2021/09/16/if-you-run-a-github-organisation-you-must-do-this-now/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.