NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(contributing): update contribution steps (#6318)

Browse Source 
See https://xcp-ng.org/forum/topic/6070/netbox-plugin-enhancements
This commit is contained in:
Pierre Donias 2022-07-11 17:01:57 +02:00 committed by GitHub
parent d847f45cb3
commit af87d6a0ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/contributing.md
View File

@ -24,16 +24,15 @@ Please, do explain:
The best way to propose a change to the documentation or code is The best way to propose a change to the documentation or code is
to create a [GitHub pull request](https://help.github.com/articles/using-pull-requests/). to create a [GitHub pull request](https://help.github.com/articles/using-pull-requests/).
:::tip 1. Fork the [Xen Orchestra repository](https://github.com/vatesfr/xen-orchestra) using the Fork button
Your pull request should always be against the `master` branch and not against `stable` which is the stable branch! 2. Follow [the documentation](installation.md#from-the-sources) to install and run Xen Orchestra from the sources
::: 3. Create a branch for your work
4. Edit the source files
1. Create a branch for your work 5. Add a summary of your changes to `CHANGELOG.unreleased.md`, if your changes do not relate to an existing changelog item and update the list of packages that must be released to take your changes into account
2. Add a summary of your changes to `CHANGELOG.md` under the `next` section, if your changes do not relate to an existing changelog item 6. [Create a pull request](https://github.com/vatesfr/xen-orchestra/compare) for this branch against the `master` branch
3. Create a pull request for this branch against the `master` branch 7. Push into the branch until the pull request is ready to merge
4. Push into the branch until the pull request is ready to merge 8. Avoid unnecessary merges: keep you branch up to date by regularly rebasing `git rebase origin/master`
5. Avoid unnecessary merges: keep you branch up to date by regularly rebasing `git rebase origin/master` 9. When ready to merge, clean up the history (reorder commits, squash some of them together, rephrase messages): `git rebase -i origin/master`
6. When ready to merge, clean up the history (reorder commits, squash some of them together, rephrase messages): `git rebase -i origin/master`
### Issue triage ### Issue triage