From d09017fa5dd71278522a1ee7bea86af4949f0fc2 Mon Sep 17 00:00:00 2001 From: Cherry Bommu Date: Sun, 14 Aug 2022 21:55:01 -0400 Subject: [PATCH] Updated "Creating a Pull Request" section to be consistent with Contribution Guidelines --- src/pages/how-do-i-contribute.mdx | 38 +++++++++++++++++++------------ 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/src/pages/how-do-i-contribute.mdx b/src/pages/how-do-i-contribute.mdx index 64ae16b..2fd7121 100644 --- a/src/pages/how-do-i-contribute.mdx +++ b/src/pages/how-do-i-contribute.mdx @@ -185,22 +185,30 @@ best to automatically resolve any conflicts. ### Creating a Pull Request -1. Fork the Github repository at https://github.com/elyra-ai/xxx if you haven't already -1. Clone your fork, create a new branch, push commits to the branch. +1. Set up SSH if you haven't already, or generate a new SSH key if necessary as described in the [Github Documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) +1. Fork the Github repository at `https://github.com/elyra-ai/` if you haven't already. +1. Clone your fork, create a new branch, and push commits to the branch as summarized below: + * Cloning your fork: + * `git clone git@github.com:elyra-ai/.git` + * Set `upstream` as described in the [GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork), preferring the SSH method over HTTPS. + * Creating a new branch: + * `git checkout -b ` + * Committing and pushing a file: + * Make changes to the necessary files, then save them with [`git add`](https://git-scm.com/docs/git-add) + * Describe the changes you made using [`git commit`](https://git-scm.com/docs/git-commit) + * Follow the [7 rules for a great commit message](http://chris.beams.io/posts/git-commit/) + * Separate subject from body with a blank line + * Limit the subject line to 50 characters + * Capitalize the subject line + * Do not end the subject line with a period + * Use the imperative mood in the subject line + * Wrap the body at 72 characters + * Use the body to explain what and why vs. how + * Submit your changes with [`git push`](https://git-scm.com/docs/git-push) 1. Consider whether documentation or tests need to be added or updated as part of the change, and add them as needed. -1. Open a pull request against the main branch of elyra-ai/elyra. (Only in special cases would the PR be opened - against other branches.) - 1. The PR title should describe the proposed change in the PR itself. - 1. If the pull request is still a work in progress, and so is not ready to be merged, but needs to be pushed - to Github to facilitate review, then prefix the PR title with `[WIP]`. - 1. Follow [The 7 rules for a great commit message](http://chris.beams.io/posts/git-commit/) - * Separate subject from body with a blank line - * Limit the subject line to 50 characters - * Capitalize the subject line - * Do not end the subject line with a period - * Use the imperative mood in the subject line - * Wrap the body at 72 characters - * Use the body to explain what and why vs. how +1. Open a pull request against the main branch of elyra-ai/<desired-elyra-repository>. (Only in special cases would the PR be opened against other branches.) +1. The PR title should describe the proposed change in the PR itself. +1. If the pull request is still a work in progress, and so is not ready to be merged, but needs to be pushed to Github to facilitate review, then prefix the PR title with `[WIP]`. ### The Review Process