Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updated contribution guide #46

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 51 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,65 @@
# How to contribute

We've strived to make the contribution process super simple! Here it is the process you should follow to contribute to this project.
Oracle welcomes contributions to this repository from anyone.

## Setup your working repo
If you want to submit a pull request to fix a bug or enhance an existing feature, please first open an issue and link to that issue when you submit your pull request.

1. Fork original repo on your GH account
If you have any questions about a possible submission, feel free to open an issue too. The contribution process is super simple. Below is what you have to do.

## Set up your working repo

1. Fork the original repo on your GitHub account
2. Clone forked version and move into its directory
3. Run `git remote add upstream https://github.com/oracle-devrel/devo.tutorials.git`

```git clone https://github.com/<myprofile>/devo.tutorials.git```

3. Add the remote upstream:

```git remote add upstream https://github.com/oracle-devrel/devo.tutorials.git```

### Add/modify your content in a branch

1. Run `git checkout main` to make sure the new branch comes from master
2. Create the new branch and switch to it: `git checkout -b <BRANCH_NAME>`
3. Do your implementation, then _stage_ and _commit_ it
* `git add .`
* `git commit -am "insert your comments here"`
1. Run `git checkout main` to make sure the new branch comes from the main branch

2. Create the new branch and switch to it:

```git checkout -b issue-<number>```

3. Write your content, then _stage_ and _commit_ it
* ```git add .```
* ```git commit -s```

4. Add your comments and use [keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) to link to your issue.

5. Push your changes to your fork:

```git push origin issue-<number>``

### Submit a Pull Request (PR)

1. Before submit a PR, check if any commits have been made to the upstream main by running:
* `git fetch upstream`
* `git checkout main`
* `git merge upstream/main`
2. If any new commits, rebase your branch
* `git checkout <BRANCH_NAME>`
* `git rebase main`
3. Commit and Push changes
* `git add .`
* `git commit -m "insert here your comments"`
* `git push origin <BRANCH_NAME>`
4. Create a Pull Request for your branch on GitHub by visiting your forked repo page.
>When you create the PR, make sure to check the <ins>"***Allow edits by maintainers***"</ins> option in the PR. This allows for easy, rapid modifications that our tech editors might provide.
5. After you submit the Pull Request, sit tight and look for any comments, edits, approvals or rejections!
1. Create a Pull Request for your branch on GitHub by visiting your forked repo page.

> When you create the PR, make sure to check the <ins>"***Allow edits by maintainers***"</ins> option in the PR. This allows for easy, rapid modifications that our tech editors might provide.

2. After you submit the Pull Request, sit tight and look for any comments, edits, approvals or rejections!

### Cleanup / Align to the source repo

1. Once your PR has been approved and merged, it's time to do some cleanup.
2. Run `git pull upstream main`
3. Remove merged branch
1. Run `git checkout main`
2. Run `git branch -d <BRANCH_NAME>`
4. Commit
5. Update the master branch in your forked repo
1. Run `git push origin main`
6. Remove the branch from your forked repo
1. Run `git push --delete origin <BRANCH_NAME>`
1. Once your PR has been approved and merged, it's time to do update your local repo.

2. Ensure you are on main:
```git checkout main```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one-line code spans use a single backtick, please. A newline must exist between a parent list item and indented paragraph/code content


3. Update your local ```main``` branch:
`git pull upstream main`

4. Remove merged branch
- Run `git branch -D issue-<number>`
5. Update your ```main``` on your GitHub:

```git push origin main```
6. Remove the branch from your forked repo:
- `git push --delete origin issue-<number>`

## How to test your edits

Expand All @@ -54,11 +69,11 @@ We don't have a staging environment right now. However if you want to see how th

## What our tech editors do

When a PR is received, our tech editors will usually refactor the content a bit, with the goal to make conveying your message as clearly as possible. Here's the process they go through to do this:
When a PR is received, our tech editors will usually refactor the content a bit, with the goal to make conveying your message as clearly as possible. Below is the process they go through:

* `git remote add pr<PR #> [email protected]/<your GH username>/devo.tutorials.git`
* `git fetch pr<PR #> <your BRANCH_NAME>`
* `git checkout -b pr<PR #> pr<PR #>/<your BRANCH_NAME>`
* `git fetch pr<PR #> issue-<number>`
* `git checkout -b pr<PR #> pr<PR #>/issue-<number>`
* Changes/edits are made
* `git add .`
* `git commit -m "Suggested edits for PR<PR #>"`
Expand Down