Awesome
How to inspect a GitHub repository
Git version control
- Each project should have a separate repository and GitHub Issues
- Set repository details in top right corner: About :gear:
- Set up environments: match branch and environment names
- Make commits with proper email address registered here on GitHub
The very first commit
If the project starts with a sample application or starter package
make the first commit with the same content and with commit message
"vendor-name/sample-app v1.2.3"
otherwise add LICENSE
file (MIT) with message "Initial commit"
Documents and configuration files
Check community standards
- Community health files
- Add configuration files and documents
- Include Requirements, Installation, Configuration,
Usage sections in
README.md
- Set editor/IDE configuration in
.editorconfig
- List ignored files in
.gitignore
- Do not keep downloaded or generated code in the repository
- List ignored OS, IDE and local environment files
in
git config --global core.excludesFile ~/.gitignore
- List files not intended to be distributed (
export-ignore
) in ZIP archives and list generated files and documentation in.gitattributes
Application setup
- Choose a coding standard (PSR-12, Laravel, custom) in
phpcs.xml
, includeGeneric.PHP.RequireStrictTypes
- Keep namespaced PHP source code in
/src
directory as per PSR-4 - Use Composer for class and function autoloading
Daily work
- Use Pull Requests to send code to the repository
- Review Pull Requests even when working alone
- Tag releases
- Follow a release checklist
See also Cleaning Lady Check list :broom::woman::memo:
Naming files in the root directory
There are several things to consider in the root directory of a repository.
- Keep only configuration files and documents in the root directory
- Name
configuration files
with lowercase letters, these are for machines - Name
DOCUMENTS
with uppercase letters, these are for humans - Use as few dot
.files
as you can - e.g.ls
command hides dot files by default
So your root will be clean, and you can differentiate configuration files from documents at a glance.
Support my work
Please consider supporting my work as these lists take years to compile.
Thank you!
Requirements
- runtime version
- other packages
Installation
- using Composer
- other ways
Configuration
- create .ini file
- adjust settings
Usage
- how to start
- code samples