https://github.com/shavo007/dotfiles-github

dotfiles to showcase githubs inner sourcing and a culture of documentation
https://github.com/shavo007/dotfiles-github

dependabot dotfiles pullrequest readme

Last synced: 5 months ago
JSON representation

dotfiles to showcase githubs inner sourcing and a culture of documentation

• Host: GitHub
• URL: https://github.com/shavo007/dotfiles-github
• Owner: shavo007
• License: mit
• Created: 2023-05-22T08:48:33.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-01T13:00:01.000Z (over 2 years ago)
• Last Synced: 2025-02-17T04:26:40.619Z (8 months ago)
• Topics: dependabot, dotfiles, pullrequest, readme
• Homepage:
• Size: 16.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Dotfiles - Recommended documentation/files to improve contribution for your tech company

Inspired by best practices, culture of documentation and [cgx](https://github.com/jeroenouw/cgx)

![Dir structure](./media/folder_structure.png)

- [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)

- [READMES](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)

- [PULL_REQUEST_TEMPLATE](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates#pull-request-templates)

- [CONTRIBUTING](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)

- [CODE OF CONDUCT](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)

## Light reading

- [Why you should add GIFs in your PRs](https://dev.to/opensauced/how-to-create-a-good-pull-request-template-and-why-you-should-add-gifs-4i0l)

- [Diagramming as code](https://diagrams.mingrammer.com/)