This GitHub Enterprise Cloud Organization is for team members of the Microsoft Sales South OU to use to provide demonstrations to their customers.
As the number of repositories for this Organization will surely grow, please see the following best practices guide when setting up your repositories.
View the Repository Best Practices Guide
- Provide a descriptive name to your repository.
| 💡 Suggestion | Use a more descriptive name like github-actions-training rather than gha-demo |
|---|
-
Provide a README.md file in the repository's root folder.
-
The repository's README.md should describe the purpose of the repository and any other useful information for users of the repository.
| 🔗 More Information | Markdown Sytax |
|---|
- If you have several related repositories, create a repository to act as the index to these other repositories. This repository need only contain a README.md with descriptions and links to the other related repositories.
| 📖 Example | See the github-actions-training repository for an example |
|---|
- Make abundant use of repository topics to make your repositories easier to find in the repository search.
eg,
traininggithubgithub-actionsreusable-workflowscicdcontinuous-integrationcontinuous-delivery
| 🔗 More Information | GitHub Topics Documentation |
|---|
- Always include your GitHub username as a topic to easily identify the owner of the repository
eg,
fredgohsman
- Provide additional documentation to help users understand, navigate, and contribute to your repository.
The following files can be added to the following folders in the repository:
- the root of the repository
- the
.githubfolder - the
docsfolder
| File Name | Purpose |
|---|---|
| CODE_OF_CONDUCT.md | A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "Adding a code of conduct to your project." |
| CONTRIBUTING.md | A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "Setting guidelines for repository contributors." |
| FUNDING.yml | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see "Displaying a sponsor button in your repository." |
| LICENSE.md | Open source license |
| README.md | Default content displayed when viewing the repository |
| SECURITY.md | A SECURITY file gives instructions for how to report a security vulnerability in your project. For more information, see "Adding a security policy to your repository." |
| SUPPORT.md | A SUPPORT file lets people know about ways to get help with your project. For more information, see "Adding support resources to your project." |
| Issue & Pull Request templates | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "About issue and pull request templates." |
| /.github/workflow-templates | Starter Workflows appear when creating a new Actions workflow. For more information see "Using starter workflows." |
| 🔗 More Information | Creating Default Community Health Files Documentation |
|---|