diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8ebbce..8943582 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,29 @@ -# Contributing guidelines for team profiles +# Contributing guidelines for meta repo -## Linux DCO +## Prerequisites -By contributing patches, you agree to the [Linux DCO](https://developercertificate.org/) and sign-off your commits (`git commit -s` or `git commit --signoff`). +### Linux DCO / CLA -**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. +By contributing patches, you agree to the [Linux DCO] and sign-off your commits by adding +a `Singed-off-by` trailer on your commit message via `git commit --signoff`. -## Updating/adding team profiles +**For community contributors**: We do not require to sign our CLA in most projects (like this), +although if we adopt the Apache CLA (instead of rolling our own via Canonical's +[Project Harmony]), we'll assume your CLA signature will make your agreement to DCO legally +binding. -> **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. +## Project-specific instructions + +### Updating/adding team profiles + +> **Note**: You should add your team profile in this repo and [not directly in wiki], 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 +gh repo clone recaptime-dev/meta # with GitHub CLI +glab repo clone https://gitlab.com/recaptime-dev/squad/meta # 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 @@ -36,3 +44,7 @@ $EDITOR CODEOWNERS git commit --signoff team/.md git push origin your-username/add-team-profile ``` + +[Project Harmony]: https://en.wikipedia.org/wiki/Project_Harmony_(licensing) +[not directly in wiki]: https://wiki.recaptime.dev +[Linux DCO]: https://developercertificate.org/ \ No newline at end of file diff --git a/templates/project/.gitignore b/templates/project/.gitignore new file mode 100644 index 0000000..c1cc1fe --- /dev/null +++ b/templates/project/.gitignore @@ -0,0 +1,10 @@ +# dotenvx / dotenv-vault +.env.keys +.env.vault +# uncomment if you don't use dotenvx +# .env +# .env.test + +.cache +*.keep +*.tmp \ No newline at end of file diff --git a/templates/project/CODE_OF_CONDUCT.md b/templates/project/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..99f57f8 --- /dev/null +++ b/templates/project/CODE_OF_CONDUCT.md @@ -0,0 +1,21 @@ +# RecapTime.dev Community Code of Conduct + +This project adopts the **Recap Time Squad Community Code of Conduct** (based off the +[Contributor Convenant v2.1]) in making a inclusive and productive space for the +community. Everyone must follow it in order to ensure safety and + +Project and community spaces within Recap Time Squad, including those within the +Hack Club Slack and its own spaces where our team members are also participating, also adopted the +[Hack Club Code of Conduct] but do note that you should contact the project maintainers +and our team first in case of emergencies before esclating to the Fire Department in HC Slack. + +## Reporting abuse + +If you seen abusive behavior in our community spaces, here are our abuse contact details: + +* Email: `abuse@recaptime.dev` (alternatively `abuse@recaptime.eu.org`) + * For email, they will be stored on our YouTrack Cloud +* Online form: (coming soon) + +[Contributor Convenant v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/ +[Hack Club Code of Conduct]: https://hackclub.com/conduct/ diff --git a/templates/project/CONTRIBUTING.md b/templates/project/CONTRIBUTING.md new file mode 100644 index 0000000..2f68e3f --- /dev/null +++ b/templates/project/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing guidelines for meta repo + +## Prerequisites + +### Linux DCO / CLA + +By contributing patches, you agree to the [Linux DCO] and sign-off your commits by adding +a `Singed-off-by` trailer on your commit message via `git commit --signoff`. + +**For community contributors**: We do not require to sign our CLA in most projects (like this), +although if we adopt the Apache CLA (instead of rolling our own via Canonical's +[Project Harmony]), we'll assume your CLA signature will make your agreement to DCO legally +binding. +