Skip to content

Commit

Permalink
[docs] document using your @elastic.co email to commit (#117428) (#11…
Browse files Browse the repository at this point in the history
…7457)

# Conflicts:
#	dev_docs/contributing/how_we_use_github.mdx
  • Loading branch information
Spencer authored Nov 4, 2021
1 parent 6fce737 commit 1fb7cb4
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/developer/contributing/development-github.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,28 @@ explanation of _why_ you made the changes that you did.
feature branch, and force-pushing (see below for instructions).
* When merging, we'll squash your commits into a single commit.

[discrete]
==== Commit using your `@elastic.co` email address

In order to assist with developer tooling we ask that all Elastic engineers use their `@elastic.co` email address when committing to the Kibana repo. We have implemented a CI check that validates any PR opened by a member of the `@elastic` organization has at least one commit that is attributed to an `@elastic.co` email address. If you have a PR that is failing because of this check you can fix your PR by following these steps:

1. Ensure that you don't have any staged changes
2. Checkout the branch for your PR
3. Update the git config for your current repository to commit with your `@elastic.co` email:
+
["source","shell"]
-----------
git config --local user.email [email protected]
-----------
4. Create a commit using the new email address
+
["source","shell"]
-----------
git commit -m 'commit using @elastic.co' --allow-empty
-----------
+
5. Push the new commit to your PR and the status should now be green

[discrete]
==== Rebasing and fixing merge conflicts

Expand Down

0 comments on commit 1fb7cb4

Please sign in to comment.