Commit e35b1c3e authored by Adam Jones's avatar Adam Jones Committed by Freedesktop SDK Merge Bot

Update documentation to explain the new git ref format

[ci skip]
parent 99e06c6b
Pipeline #37065943 skipped
......@@ -33,7 +33,7 @@ git clone git@gitlab.com:freedesktop-sdk/freedesktop-sdk
```
to avoid having to type your password when pushing.
Please make sure that your git is connected with your email and name using
Please make sure that your git is connected with your email and name using
```
git config user.name "MY_NAME"
git config user.email "MY_EMAIL@example.com"
......@@ -67,6 +67,34 @@ When writing commit messages follow these rules:
For more information on git commit messages see [this guide](https://chris.beams.io/posts/git-commit/#seven-rules/).
## When modifying a git source
We use tools to track versions/security vulnerabilities, this requires us to
track the exact version number we are using.
Freedesktop-sdk does not utilise a traditional sha format, we combine
the version number, number of commits from the tag(HEAD) and then the sha,
which is easier to parse and automate.
When modifying a "ref" (bst sha) for a git source, you need to generate a new
ref format for the new version, this is possible by running:
```
git describe --tags --long --abbrev=40
```
Which should produce something like:
```
freedesktop-sdk-18.08.18-116-g30eb35057d1e2b0beb539b92d3af6708c252d21b
```
This ref clearly states the project version in a human readable format, whilst
also making it easier to regex/automate the parsing of the version by other
tools.
## Request developer access to the freedesktop-sdk repo
Go to our gitlab [project page](https://gitlab.com/freedesktop-sdk/freedesktop-sdk) and click the "Request Developer Access" button near the top of the page. One of the maintainers will review your request. Developer access allows you to push directly to our repo, enabling a simpler "push and merge request" workflow instead of using the github "fork and pull request" workflow.
This has the added benefit of allowing you to use our CI, which is equipped with runners for aarch64, armv7, i686 and x86_64 architectures.
......
......@@ -106,7 +106,7 @@ The `plugins/` directory contains our custom Buildstream
## Contributing
For a guide to contributing, please see our CONTRIBUTING file.
For a guide to contributing, please see our [CONTRIBUTING](https://gitlab.com/freedesktop-sdk/freedesktop-sdk/blob/18.08/CONTRIBUTING.md) file.
## Acknowledgements
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment