Skip to content

Commit

Permalink
docs: update CONTRIBUTING.md (#5668)
Browse files Browse the repository at this point in the history
* docs: update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

---------

Co-authored-by: Cristina Cañizales <[email protected]>
  • Loading branch information
daphne-sfdc and CristiCanizales authored Jul 2, 2024
1 parent c6e93d8 commit 2566469
Showing 1 changed file with 8 additions and 46 deletions.
54 changes: 8 additions & 46 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@

1. Familiarize yourself with the codebase by reading the [docs](docs), in
particular the [development](contributing/developing.md) doc.
1. Create a new issue before starting your project so that we can keep track of
what you are trying to add/fix. That way, we can also offer suggestions or
let you know if there is already an effort in progress.
1. Create a new discussion before starting your project so that we are aware of what you are trying to add/fix. On that discussion, we will give you the approval to proceed if your suggestion fits in our roadmap, offer suggestions, or let you know if there is already an effort in progress.
1. Fork this repository.
1. The [README](README.md) has details on how to set up your environment.
1. Create a _topic_ branch in your fork based on the correct branch (usually the **develop** branch, see [Branches section](#branches) below). Note, this step is recommended but technically not required if contributing using a fork.
1. Optional: Create a _topic_ branch in your fork based on the correct branch (usually the **develop** branch). Note, this step is recommended but technically not required if contributing using a fork.
1. Edit the code in your fork.
1. Sign CLA (see [CLA](#cla) below)
1. Send us a pull request when you are done. We'll review your code, suggest any
needed changes, and merge it in.
1. Sign the CLA (see [CLA](#cla) below)
1. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in. We will only accept and review pull requests that contain unit tests.
1. Please provide us with a one-pager with your pull request to help us understand your code. In the one-pager, explain what the change is, why it is necessary, and how you made the change. The one-pager should include a test plan so we can get an idea of how you have tested your code changes. We would also greatly appreciate a short demo video of the expected behavior of your feature.

### Committing

Expand All @@ -24,47 +22,11 @@
External contributors will be required to sign a Contributor's License
Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.

## Branches

- We work in `develop`.
- Our released (aka. _production_) branch is `main`.
- Our work happens in _topic_ branches (feature and/or bug-fix).
- feature as well as bug-fix branches are based on `develop`
- branches _should_ be kept up-to-date using `rebase`
- see below for further merge instructions

### Merging between branches

- We try to limit merge commits as much as possible.

- They are usually only ok when done by our release automation.

- _Topic_ branches are:

1. based on `develop` and will be
1. squash-merged into `develop`.

- Hot-fix branches are an exception.
- Instead we aim for faster cycles and a generally stable `develop` branch.

### Merging `develop` into `main`

- When a development cycle finishes, the content of the `develop` branch becomes the `main` branch.

```
$ git checkout main
$ git reset --hard develop
$
$ # Using a custom commit message for the merge below
$ git merge -m 'Merge -s our (where _ours_ is develop) releasing stream x.y.z.' -s ours origin/main
$ git push origin main
```

## Pull Requests

- Develop features and bug fixes in _topic_ branches.
- _Topic_ branches can live in forks (external contributors) or within this repository (committers).
\*\* When creating _topic_ branches in this repository please prefix with `<developer-name>/`.
- Develop features and bug fixes in your fork of the repository.
- When you are done, create a pull request for us to review.
- When we review your pull request, we will create a feature branch from your code to trigger the required checks and keep the feature branch updated with your fork.

### Merging Pull Requests

Expand Down

0 comments on commit 2566469

Please sign in to comment.