forked from microsoft/demikernel
/
CONTRIBUTING
65 lines (42 loc) · 2.44 KB
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Contributing
=============
Everyone is welcome to contribute to this project.
Bellow, you find some guidelines to help you on this.
Special Branches
-----------------
There are three special branches in this project:
- `master`: which you get all extensively-tested features
- `unstable`: which includes beta features
- `dev`: where all changes are introduced first
From a practical point of view, you should use these branches as follows:
- Rely on `master` whenever you want to use this project in a stable environment.
- Get `unstable` whenever you want to use this project in an experimental environment.
- Use `dev` whenever you want to introduce changes to this project.
Naming Branches
----------------
We rely on a naming convention for branches in order to:
- make it easier to navigate across the history of the project, and
- automatically run continuous integration workflows.
In a nutshell, branches that follow this convention are named according to their purpose:
- `feature-<module>-<issue>` for new features
- `enhancement-<module>-<issue>` for improvements on an existing feature
- `bugfix-<module>-<issue>` for permanent bug fixes on existing features
- `workaround-<module>-<issue>` for temporary bug fixes on existing features
Submitting Pull Requests
-------------------------
- Make sure that your local `dev` branch is up-to-do-date with `upstream/dev`.
- Create a branch from `dev` with your changes.
- Use naming conventions stated in this guide to name your branch.
- Add your changes to your local branch.
- Open a pull request from your branch to `dev`.
Additional Information
-----------------------
Most contributions require you to agree to a Contributor License Agreement (CLA)
declaring that you have the right to, and actually do, grant us the rights to
use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.