Choose your branch

Before fixing any typo or writing any new articles, you will need to know on which branch(es) to apply your changes.

The rules are pretty simple.

First rule: 🚀 "Everything you merge on v2, v3, v4 and master is automatically deployed in production." 🚀
What does it mean?
Basically, it means that you can't merge what we call "partial" documentation: for example, without screenshots or without English proofreading. If you need to separate your work in several PRs, create your own feature branch in which you can progressively merge your PRs. And then, when you're done with your documentation on this feature, merge this branch into the final destination branch. 😉

For the typos:

• You spotted a typo on the v2 version of the doc. Your changes need to be merged on v2. Then, cherry-pick your changes on all the following branches: v3, v4 and master.
• You spotted a typo on the v3 version of the doc. Your changes need to be merged on v3. Then, cherry-pick your changes on all the following branches: v4 and master.
• You spotted a typo on the v4 version of the doc. Your changes need to be merged on v4. Then, cherry-pick your changes on all the following branches: master.
• You spotted a typo on the Serenity version of the doc. Your changes need to be merged on master. And that's it!

For new content:

• You forgot to write content for a v4 feature. You will need to merge your new articles/sections into v4 and then, cherry-pick your changes on master.
• You want to write new content for a Serenity feature. You will need to merge your new articles/sections into master.
  Important note: Be sure to synchronize your doc merge with the PIM code merge of your feature. Indeed, we need to ensure that every new feature that appears in the PIM is correctly documented in this help center AND that every PIM feature documented in this help center is actually available in the PIM.
  Small tip: Your squad is working on a big feature that will be available in a month, but you want to save time by progressively writing the documentation? Good for you! Create a feature branch, named for example chipmunks-rules. Then, merge progressively your PRs in it.