Add in contributing file

This commit is contained in:
Ryan van Zeben
2023-09-15 13:07:14 -04:00
committed by GitHub
parent 7f4f5606ff
commit 0ac3a85234

19
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,19 @@
# Contributing
## Submitting a pull request
1. Fork and clone the repository
1. Create a new branch: `git checkout -b my-branch-name`
1. Push to your fork and submit a pull request
1. Pat yourself on the back and wait for your pull request to be reviewed and merged
## Tips for working this repository:
> - The repository is huge right now, you don't want to waste your time and disk space to get those unrelated files.
> - Ignore LFS files during initial `git clone` the repo with `GIT_LFS_SKIP_SMUDGE=1 git clone https://mseng@dev.azure.com/mseng/AzureDevOps/_git/CIPlat.Externals`
> - Ignore LFS files during any `git checkout` or `git fetch` operation with `GIT_LFS_SKIP_SMUDGE=1`.
> - You do want the LFS smudge filter to run during `git add` and `git push`, make sure you don't have `GIT_LFS_SKIP_SMUDGE=1` when you run `git add` and `git push`.
> - More `Git-LFS` doc is at https://github.com/git-lfs/git-lfs/tree/main/docs
Thanks! :heart: :heart: :heart:
GitHub Actions Team :octocat: