From 5d65bcf53651e71a2af8f2f8a53c18625bcd0626 Mon Sep 17 00:00:00 2001 From: Adam Gardner <26523841+agardnerIT@users.noreply.github.com> Date: Wed, 30 Aug 2023 17:08:20 +1000 Subject: [PATCH] docs: move contributing to website Signed-off-by: Adam Gardner <26523841+agardnerIT@users.noreply.github.com> --- CONTRIBUTING.md | 110 +------------------------------------- mkdocs.yml | 1 + web-docs/contributing.md | 111 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 113 insertions(+), 109 deletions(-) create mode 100644 web-docs/contributing.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 60c546762..9c5259aa8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,111 +1,3 @@ # Welcome -There are a few things to consider before contributing to flagd. - -Firstly, there's [a code of conduct](https://github.com/open-feature/.github/blob/main/CODE_OF_CONDUCT.md). -TLDR: be respectful. - -Any contributions are expected to include unit tests. -These can be validated with `make test` or the automated github workflow will run them on PR creation. - -This project uses a go workspace, to setup the project run - -```shell -make workspace-init -``` - -The go version in the `go.work` is the currently supported version of go. - -The project uses remote buf packages, changing the remote generation source will require a one-time registry configuration: - -```shell -export GOPRIVATE=buf.build/gen/go -``` - -## DCO Sign-Off - -A DCO (Developer Certificate of Origin) sign-off is a line placed at the end of -a commit message containing a contributor's "signature." In adding this, the -contributor certifies that they have the right to contribute the material in -question. - -Here are the steps to sign your work: - -1. Verify the contribution in your commit complies with the - [terms of the DCO](https://developercertificate.org/). - -1. Add a line like the following to your commit message: - - ```shell - Signed-off-by: Joe Smith - ``` - - You MUST use your legal name -- handles or other pseudonyms are not - permitted. - - While you could manually add DCO sign-off to every commit, there is an easier - way: - - 1. Configure your git client appropriately. This is one-time setup. - - ```shell - git config user.name - git config user.email - ``` - - If you work on multiple projects that require a DCO sign-off, you can - configure your git client to use these settings globally instead of only - for Brigade: - - ```shell - git config --global user.name - git config --global user.email - ``` - - 1. Use the `--signoff` or `-s` (lowercase) flag when making each commit. - For example: - - ```shell - git commit --message "" --signoff - ``` - - If you ever make a commit and forget to use the `--signoff` flag, you - can amend your commit with this information before pushing: - - ```shell - git commit --amend --signoff - ``` - - 1. You can verify the above worked as expected using `git log`. Your latest - commit should look similar to this one: - - ```shell - Author: Joe Smith - Date: Thu Feb 2 11:41:15 2018 -0800 - - Update README - - Signed-off-by: Joe Smith - ``` - - Notice the `Author` and `Signed-off-by` lines match. If they do not, the - PR will be rejected by the automated DCO check. - -## Conventional PR Titles - -When raising PRs, please format according to [conventional commit standards](https://www.conventionalcommits.org/en/v1.0.0/#summary) - -For example: `docs: some PR title here...` - -Thanks! -Issues and pull requests following these guidelines are welcome. - -## Markdown Lint and Markdown Lint Fix - -PRs are expected to conform to markdown lint rules. - -Therefore, run `make markdownlint-fix` to auto-fix _most_ issues. -Then commit the results. - -For those issues that cannot be auto-fixed, run `make markdownlint` -then manually fix whatever it warns about. +This page has now moved: [contributing to flagd](https://flagd.dev/contributing) diff --git a/mkdocs.yml b/mkdocs.yml index 7f9ea8b2d..b2a53acab 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,5 +53,6 @@ nav: - 'Flagd Telemetry': - 'Flagd OpenTelemetry Support': 'concepts/opentelemetry.md' - 'Troubleshooting': 'troubleshooting.md' + - 'Contributing': 'contributing.md' plugins: - social \ No newline at end of file diff --git a/web-docs/contributing.md b/web-docs/contributing.md new file mode 100644 index 000000000..2f73beccd --- /dev/null +++ b/web-docs/contributing.md @@ -0,0 +1,111 @@ +# Contributing to flagd + +There are a few things to consider before contributing to flagd. + +Firstly, there's [a code of conduct](https://github.com/open-feature/.github/blob/main/CODE_OF_CONDUCT.md). +TLDR: be respectful. + +Any contributions are expected to include unit tests. +These can be validated with `make test` or the automated github workflow will run them on PR creation. + +This project uses a go workspace, to setup the project run + +```shell +make workspace-init +``` + +The go version in the `go.work` is the currently supported version of go. + +The project uses remote buf packages, changing the remote generation source will require a one-time registry configuration: + +```shell +export GOPRIVATE=buf.build/gen/go +``` + +## DCO Sign-Off + +A DCO (Developer Certificate of Origin) sign-off is a line placed at the end of +a commit message containing a contributor's "signature." In adding this, the +contributor certifies that they have the right to contribute the material in +question. + +Here are the steps to sign your work: + +1. Verify the contribution in your commit complies with the + [terms of the DCO](https://developercertificate.org/). + +1. Add a line like the following to your commit message: + + ```shell + Signed-off-by: Joe Smith + ``` + + You MUST use your legal name -- handles or other pseudonyms are not + permitted. + + While you could manually add DCO sign-off to every commit, there is an easier + way: + + 1. Configure your git client appropriately. This is one-time setup. + + ```shell + git config user.name + git config user.email + ``` + + If you work on multiple projects that require a DCO sign-off, you can + configure your git client to use these settings globally instead of only + for Brigade: + + ```shell + git config --global user.name + git config --global user.email + ``` + + 1. Use the `--signoff` or `-s` (lowercase) flag when making each commit. + For example: + + ```shell + git commit --message "" --signoff + ``` + + If you ever make a commit and forget to use the `--signoff` flag, you + can amend your commit with this information before pushing: + + ```shell + git commit --amend --signoff + ``` + + 1. You can verify the above worked as expected using `git log`. Your latest + commit should look similar to this one: + + ```shell + Author: Joe Smith + Date: Thu Feb 2 11:41:15 2018 -0800 + + Update README + + Signed-off-by: Joe Smith + ``` + + Notice the `Author` and `Signed-off-by` lines match. If they do not, the + PR will be rejected by the automated DCO check. + +## Conventional PR Titles + +When raising PRs, please format according to [conventional commit standards](https://www.conventionalcommits.org/en/v1.0.0/#summary) + +For example: `docs: some PR title here...` + +Thanks! +Issues and pull requests following these guidelines are welcome. + +## Markdown Lint and Markdown Lint Fix + +PRs are expected to conform to markdown lint rules. + +Therefore, run `make markdownlint-fix` to auto-fix _most_ issues. +Then commit the results. + +For those issues that cannot be auto-fixed, run `make markdownlint` +then manually fix whatever it warns about.