Add some more policies, including contributing guidelines

This commit is contained in:
Andrei Jiroh Halili 2023-08-16 00:49:19 +08:00 committed by GitHub
parent 7fda32a739
commit d69273035f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 202 additions and 7 deletions

38
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,38 @@
# Contributing guidelines for team profiles
## Linux DCO
By contributing patches, you agree to the [Linux DCO](https://developercertificate.org/) and sign-off your commits (`git commit -s` or `git commit --signoff`).
**For community contributors**: We do not require to sign our CLA in most projects (like this), although if you did, we'll assume your CLA signature will make your agreement to DCO legally binding.
## Updating/adding team profiles
> **Note**: You should add your team profile in this repo and not in [`gh:recaptime-dev/website-next`](https://github.com/recaptime-dev/website-next), due to how we setup CI for one-way synchorization.
For new members during onboarding, create your own team profile by [copying the template file] and fill in with your own.
```shell
# branch off if you have direct push access to the repo or fork to personal namespace
gh repo clone recaptime-dev/squad # with GitHub CLI
glab repo clone https://mau.dev/recaptime-dev/squad/gitlab-profile # with GitLab CLI
# option A: branch off (you can also branch off on your fork to keep things seperate
# from your own main branch)
git switch -c your-username/add-team-profile
# option B: fork via existing copy
gh repo fork recaptime-dev/squad --default-branch-only --remote
glab repo fork recaptime-dev/squad --remote
# first copy the template file into an new markdown file
cp team/template.md team/<your-github-username-in-lowercase>.md
# edit with your own details
$EDITOR team/<your-github-username-in-lowercase>.md
# make sure to protect your team profile file via CODEOWNERS
$EDITOR CODEOWNERS
# stage, sign-off and send a patch
git commit --signoff team/<your-github-username-in-lowercase>.md
git push origin your-username/add-team-profile
```