Skip to content

Commit 9e77043

Browse files
committed
1 parent 643dd4e commit 9e77043

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/Developers/index.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,45 @@ Services will grow over time, we may split up the buildstack menu into subsectio
5252
* Any configs that are required before getting the service running should be configured in the service's options menu (and a BuildStack menu Issue should be displayed if not).
5353
* Fork the repo and push the changes to your fork. Create a cross repo PR for the mods to review. We may request additional changes from you.
5454

55+
## Commit message
56+
57+
```
58+
service_name: Add/Fix/Change feature or bug summary
59+
60+
Optional longer description of the commit. What is changed and why it
61+
is changed. Wrap at 72 characters.
62+
63+
* You can use markdown formating as this will automatically be the
64+
description of your pull-request.
65+
* End by adding any issues this commit fixes, one per line:
66+
67+
Fixes #1234
68+
Fixes #4567
69+
```
70+
71+
1. The first line is a short description. Keep it short, aim for 50
72+
characters. This is like the subject of an email. It shouldn't try to fully
73+
or uniquely describe what the commit does. More importantly it should aim
74+
to inform *why* this commit was made.
75+
76+
`service_name` - service or project-part being changed, e.g. influxdb,
77+
grafana, docs. Documentation changes should use the the name of the
78+
service. Use `docs` if it's changes to general documentation. If all else
79+
fails, use the folder-name of the file you are changing. Use lowercase.
80+
81+
`Add/Fix/Change` - what type of an change this commit is. Capitalized.
82+
83+
`feature or bug summary` - free very short text giving an idea of why/what.
84+
85+
2. Empty line.
86+
87+
3. A longer description of what and why. Wrapped to 72 characters.
88+
89+
Use [github issue linking](
90+
https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
91+
to automatically close issues when the pull-request of this commit is
92+
merged.
93+
5594
## Follow up
5695
If your new service is approved and merged then congratulations! Please watch the Issues page on github over the next few days and weeks to see if any users have questions or issues with your new service.
5796

0 commit comments

Comments
 (0)