From d23cf9e2aa6b3cb2d89bdc6d6ecf583a6b87ef89 Mon Sep 17 00:00:00 2001 From: Dawn Pattison Date: Mon, 1 Nov 2021 20:26:56 -0500 Subject: [PATCH 1/2] Add more instructions for forking the repo beyond just linking to Github docs. --- docs/fidesops/docs/development/overview.md | 25 ++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/docs/fidesops/docs/development/overview.md b/docs/fidesops/docs/development/overview.md index ed8c13fb3..6a56637a9 100644 --- a/docs/fidesops/docs/development/overview.md +++ b/docs/fidesops/docs/development/overview.md @@ -16,8 +16,9 @@ commands to give you different functionality. 1. Install Docker: https://docs.docker.com/desktop/#download-and-install 2. Install `make` locally (see Make on Homebrew (Mac), Make for Windows, or your preferred installation) 1. `brew install make` -3. Clone fidesops `git clone https://github.com/ethyca/fidesops.git` -4. `cd fidesops` +3. [Create a fork of fidesops](https://docs.github.com/en/get-started/quickstart/fork-a-repo) +4. Clone your fork `git clone https://github.com//fidesops.git` +5. `cd fidesops` ### Available make commands - `make server` - this spins up the Fastapi server and supporting resources (a Postgres database and a Redis cache), which you can visit at `http://0.0.0.0:8080`. Check out the docs at `http://0.0.0.0:8000/fidesops/` @@ -34,7 +35,7 @@ commands to give you different functionality. - `make check-migrations` - verifies there are no un-run migrations - `make docs-serve` - spins up just the docs -see [Makefile](../../../../Makefile) for more options. +See [Makefile](../../../../Makefile) for more options. #### Issues @@ -44,7 +45,7 @@ and then run `pip install -e .`. Verify Fidesops is installed with `pip list`. ### Write your code -We have no doubt you can write amazing code! However, we want to help you ensure your code plays nicely with the rest of the Fides ecosystem. Many projects describe code style and documentation as a suggestion; in Fides it's a CI-checked requirement. +We have no doubt you can write amazing code! However, we want to help you ensure your code plays nicely with the rest of the Fidesops ecosystem. Many projects describe code style and documentation as a suggestion; in Fidesops it's a CI-checked requirement. * To learn how to style your code, see the [style guide](code_style.md). * To learn how to document your code, see the [docs guide](documentation.md). @@ -56,10 +57,22 @@ We have no doubt you can write amazing code! However, we want to help you ensure In order to submit code to Fidesops, please: * [Fork the Fidesops repository](https://help.github.com/en/articles/fork-a-repo) +* Add the original as a remote (I'm naming it `upstream`), to keep your fork in sync + * `git remote add upstream https://github.com/ethyca/fidesops.git` * [Create a new branch](https://help.github.com/en/desktop/contributing-to-projects/creating-a-branch-for-your-work) on your fork + ```bash + git checkout main + git fetch upstream + git merge upstream/main + git push origin main + git checkout -b my-new-branch + git push origin my-new-branch + ``` * [Open a Pull Request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) once your work is ready for review -* Once automated tests have passed, a maintainer will review your PR and provide feedback on any changes it requires to be approved. Once approved, your PR will be merged into Fides. + * Submit the pull request from *your* repo + * Once automated tests have passed, a maintainer will review your PR and provide feedback on any changes it requires to be approved. Once approved, your PR will be merged into Fidesops. + ### Congratulations -You're a Fides contributor - welcome to the team! 🎉 +You're a Fidesops contributor - welcome to the team! 🎉 From ef640a26d66dbd63ed711e8dcae7f98550797003 Mon Sep 17 00:00:00 2001 From: Dawn Pattison Date: Mon, 1 Nov 2021 20:29:26 -0500 Subject: [PATCH 2/2] Fix formatting. --- docs/fidesops/docs/development/overview.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/fidesops/docs/development/overview.md b/docs/fidesops/docs/development/overview.md index 6a56637a9..0b0633e81 100644 --- a/docs/fidesops/docs/development/overview.md +++ b/docs/fidesops/docs/development/overview.md @@ -58,7 +58,9 @@ In order to submit code to Fidesops, please: * [Fork the Fidesops repository](https://help.github.com/en/articles/fork-a-repo) * Add the original as a remote (I'm naming it `upstream`), to keep your fork in sync - * `git remote add upstream https://github.com/ethyca/fidesops.git` + ```bash + git remote add upstream https://github.com/ethyca/fidesops.git + ``` * [Create a new branch](https://help.github.com/en/desktop/contributing-to-projects/creating-a-branch-for-your-work) on your fork ```bash git checkout main