Skip to content

README.md

Latest commit

 

History

History
39 lines (27 loc) · 1.32 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.32 KB
Raw

.github

Organization-wide defaults for MailCoded.

Path What it is
profile/README.md the organization landing page, rendered at https://github.com/MailCoded

GitHub renders the landing page only from a repository named exactly .github whose visibility is public; a member-only variant would live in a private .github-private repository instead. The file must be README.md inside a profile folder.

Publishing

Against a repository that does not exist yet:

gh repo create MailCoded/.github --public --source . --push

Against an empty repository that already exists:

git init && git add . && git commit -m "docs: add the organization profile"
git remote add origin git@github.com:MailCoded/.github.git
git push -u origin main

Nothing here is built or tested. Edit and push.

What else this repository can hold

Files placed here are inherited by every repository in the organization that does not define its own. None of these exist yet, in this repository or in mailcoded:

  • SECURITY.md — how to report a vulnerability privately. Worth having before the first release, since this project handles mail credentials.
  • CONTRIBUTING.md, CODE_OF_CONDUCT.md
  • .github/ISSUE_TEMPLATE/, .github/PULL_REQUEST_TEMPLATE.md