From 3714f6299b22dd4aa4b53fd300e164b6283afb5d Mon Sep 17 00:00:00 2001 From: Andre Wanlin Date: Sat, 11 Nov 2023 20:29:30 -0600 Subject: [PATCH 1/3] fix: added TOC to contributing guide Signed-off-by: Andre Wanlin --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c645ab524..a0138a5e44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,21 @@ You can find out more about the types of contributions over at [getting involved If you need help, just jump into our [Discord chatroom](https://discord.gg/backstage-687207715902193673). +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [Security Issues?](#security-issues) +- [Accessibility](#accessibility) +- [Get Started!](#get-started) +- [Coding Guidelines](#coding-guidelines) +- [Package Scripts](#package-scripts) +- [Local configuration](#local-configuration) +- [Creating Changesets](#creating-changesets) +- [Developer Certificate of Origin](#developer-certificate-of-origin) +- [API Reports](#api-reports) +- [Submitting a Pull Request](#submitting-a-pull-request) +- [Review Process](#review-process) + ## Code of Conduct This project adheres to the [CNCF Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code. From 4a1dfae9d52c64d6231af365ac5136fcac7bf619 Mon Sep 17 00:00:00 2001 From: Andre Wanlin Date: Sat, 11 Nov 2023 20:40:47 -0600 Subject: [PATCH 2/3] chore: dco improvements Signed-off-by: Andre Wanlin --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0138a5e44..d34f45005e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -288,6 +288,13 @@ Awesome commit message Signed-off-by: Jane Smith ``` +> Note: this assumes you have setup your git name and email, if you haven you can use these commands to set that up: +> +> ```shell +> git config --global user.name "Your Name" +> git config --global user.email "youremail@example.com" +> ``` + - In case you forgot to add it to the most recent commit, use `git commit --amend --signoff` - In case you forgot to add it to the last N commits in your branch, use `git rebase --signoff HEAD~N` and replace N with the number of new commits you created in your branch. - If you have a very deep branch with a lot of commits, run `git rebase -i --signoff $(git merge-base -a master HEAD)`, double check to make sense of the commits (keep all lines as `pick`) and save and close the editor. This should bulk sign all the commits in your PR. Do be careful though. If you have a complex flow with a lot of branching and re-merging of work branches and stuff, merge-base may not be the right solution for you. @@ -306,6 +313,16 @@ Signed-off-by: Jane Smith In case you forgot to add the line to your most recent commit, you can amend the commit message from the History tab before pushing your branch (GitHub Desktop 2.9 or later). +### Using VS Code? + +If you are using VS Code you can enable always signing your commits by setting the following in your `settings.json`: + +```json +"git.alwaysSignOff": true, +``` + +Or from the Settings UI look for the "Git: Always Sign Off" setting and check the "Controls the signoff flag for all commits" box + ## API Reports Backstage uses [API Extractor](https://api-extractor.com/) and TSDoc comments to generate API Reports in Markdown format. These reports are what drive the [API Reference documentation](https://backstage.io/docs/reference/). What this means is that if you are making changes to the API or adding a new plugin then you will need either generate a new API Report or update an existing API Report. If you don't do this the CI build will fail when you create your Pull Request. From a84ef87501e578e91c1c147d98692407272e7d5c Mon Sep 17 00:00:00 2001 From: Andre Wanlin Date: Sat, 11 Nov 2023 21:03:44 -0600 Subject: [PATCH 3/3] chore: fixed typos Signed-off-by: Andre Wanlin --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d34f45005e..1261e7debc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -288,7 +288,7 @@ Awesome commit message Signed-off-by: Jane Smith ``` -> Note: this assumes you have setup your git name and email, if you haven you can use these commands to set that up: +> Note: this assumes you have setup your git name and email, if you have not you can use these commands to set that up: > > ```shell > git config --global user.name "Your Name" @@ -305,7 +305,7 @@ Note: If you have already pushed your branch to a remote, you might have to forc If you are using the GitHub Desktop client, you need to manually add the `Signed-off-by` line to the Description field on the Changes tab before committing: -``` +```text Awesome description (commit message) Signed-off-by: Jane Smith @@ -315,13 +315,13 @@ In case you forgot to add the line to your most recent commit, you can amend the ### Using VS Code? -If you are using VS Code you can enable always signing your commits by setting the following in your `settings.json`: +If you are using VS Code you can enable always signing your commits by setting the following in your `settings.json` file: ```json "git.alwaysSignOff": true, ``` -Or from the Settings UI look for the "Git: Always Sign Off" setting and check the "Controls the signoff flag for all commits" box +Or from the Settings UI look for the "Git: Always Sign Off" setting and check the "Controls the signoff flag for all commits" box. ## API Reports