You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
doc: Rework docs to align with Rust and other libs (#93)
* Initial README edit
* Update info on PR titles and commit messages
* Remove note about (IGNORE) in PRs
* Move generated API docs to api-docs dir, split README into 3 new files in docs dir
* Align with latest changes
* Heading reorg
* Make gh/doc links consistent
* trying to fix links
* Trying to fix README links
* Add link to supported formats
* Change title for consistencty
* Modify GH only blurb
* Review feedback from @tmathern
Start by filing an issue. The existing committers on this project work to reach
16
16
consensus around project direction and issue solutions within issue threads
17
17
(when appropriate).
18
18
19
-
## Contributor License Agreement
19
+
## Contributor license agreement
20
20
21
21
All third-party contributions to this project must be accompanied by a signed contributor
22
22
license agreement. This gives Adobe permission to redistribute your contributions
23
23
as part of the project. [Sign our CLA](https://opensource.adobe.com/cla.html). You
24
24
only need to submit an Adobe CLA one time, so if you have submitted one previously,
25
25
you are good to go!
26
26
27
-
## Code Reviews
27
+
## Code reviews
28
28
29
29
All submissions should come in the form of pull requests and need to be reviewed
30
30
by project committers. Read [GitHub's pull request documentation](https://help.github.com/articles/about-pull-requests/)
@@ -36,7 +36,39 @@ These include such things as Rust code format, Clippy/lint checks, and unit test
36
36
We encourage you to raise an issue in GitHub before starting work on a major addition to the crate.
37
37
This will give us an opportunity to discuss API design and avoid duplicate efforts.
38
38
39
-
## From Contributor to Committer
39
+
### Pull request titles
40
+
41
+
Titles of pull requests that target a long-lived branch such as _main_ or a release-specific branch should follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#specification). This means that the first word of the pull request title should be one of the following:
42
+
43
+
*`build`
44
+
*`chore`
45
+
*`ci`
46
+
*`docs`
47
+
*`feat`
48
+
*`fix`
49
+
*`perf`
50
+
*`refactor`
51
+
*`revert`
52
+
*`style`
53
+
*`test`
54
+
55
+
Optionally, but preferred, a scope can be added in parentheses after the type. The scope should be the name of the module or component that the commit affects. For example, `feat(api): Introduce a new API to validate 1.0 claims`.
56
+
57
+
If more detail is warranted, add a blank line and then continue with sentences (these sentences should be punctuated as such) and paragraphs as needed to provide that detail. There is no need to word-wrap this message.
58
+
59
+
For example:
60
+
61
+
```text
62
+
feat(api): Introduce a new API to validate 1.0 claims
63
+
64
+
Repurpose existing v2 API for 0.8 compatibility (read: no validation) mode.
65
+
```
66
+
67
+
The conventional commit message requirement does not apply to individual commits within a pull request, provided that those commits will be squashed when the PR is merged and the resulting squash commit does follow the conventional commit requirement. This may require the person merging the PR to verify the commit message syntax when performing the squash merge.
68
+
69
+
TIP: For single-commit PRs, ensure the commit message conforms to the conventional commit requirement, since by default that will also be the title of the PR.
70
+
71
+
## From contributor to committer
40
72
41
73
We love contributions from our community! If you'd like to go a step beyond contributor
42
74
and become a committer with full write access and a say in the project, you must
@@ -45,7 +77,7 @@ process that must reach lazy consensus (silence is approval) before invitations
45
77
are issued. If you feel you are qualified and want to get more deeply involved,
46
78
feel free to reach out to existing committers to have a conversation about that.
47
79
48
-
## Security Issues
80
+
## Security issues
49
81
50
82
Do not create a public GitHub issue for any suspected security vulnerabilities. Instead, please file an issue through [Adobe's HackerOne page](https://hackerone.com/adobe?type=team).
51
83
For more information on reporting security issues, see [SECURITY.md](SECURITY.md).
0 commit comments