@@ -15,8 +15,8 @@ Welcome! Thanks for looking into contributing to our project!
1515
1616# Ways to Contribute
1717
18- We are looking This document below primarily focuses on writing code for this
19- project, but there are many ways you can help out:
18+ This document below primarily focuses on writing code for this
19+ project, but there are many different ways you can help out:
2020
2121- ** Testing** : We only have access to a limited set of hardware and accounts.
2222 Installing the project and using it yourself is a great way to get us more
@@ -49,7 +49,8 @@ Here is a list of helpful resources you can consult:
4949
5050## Documentation
5151
52- Before getting started, it may help you to read the documentation. Take a look at these:
52+ To help you get started, we have provided documentation for various parts of the
53+ project. Take a look at these:
5354
5455- [ credentialsd API Specification] ( /doc/api.md )
5556- [ ARCHITECTURE.md] ( /ARCHITECTURE.md ) , our architecture guide.
@@ -98,7 +99,8 @@ For internal consistency, credentialsd uses `snake_case` for D-Bus field names
9899and ` SCREAMING_SNAKE_CASE ` for enum values. This is consistent with D-Bus
99100conventions, but it is distinct from Web Credential Management/WebAuthn
100101conventions, which this API is based on. Values specified within JSON string
101- payloads should stick to the naming conventions as specified in the WebAuthn.
102+ payloads should stick to the naming conventions as documented in the WebAuthn
103+ spec.
102104
103105### Code Formatting and Linting
104106
@@ -149,6 +151,11 @@ Write commit messages using the imperative mood, as if completing the sentence:
149151"If applied, this commit will \_\_\_ ." For example, use "Fix some bug" instead
150152of "Fixed some bug" or "Add a feature" instead of "Added a feature".
151153
154+ Some examples:
155+
156+ - "daemon: Allow clients to cancel their own requests"
157+ - "ui: Allow users to go back to device selection"
158+
152159(Take a look at this [ blog post] [ commit-messages-guide ] for more information on
153160writing good commit messages.)
154161
@@ -183,5 +190,5 @@ make sure that your changes can build and pass all tests, as well as running the
183190formatting and linting tools [ mentioned above] ( #code-formatting-and-linting ) .
184191
185192You should also follow the install instructions in [ ` BUILDING.md ` ] ( /BUILDING.md )
186- and execute authentication flows in a browser the to ensure that everything
193+ and execute authentication flows in a browser to ensure that everything
187194still works as it should.
0 commit comments