Skip to content

Commit cf7b581

Browse files
authored
docs: add getting involved section to contribution guidelines (#317)
1 parent 808aaad commit cf7b581

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
1-
## Contributing
1+
# Contributing
22

3-
### Commit and PR linting
3+
## Getting Involved
4+
5+
We welcome contributions and are happy to discuss ideas, answer questions, and help you get started.
6+
7+
**Before opening a pull request**, please open an issue or start a discussion with the maintainers. This helps us:
8+
- Ensure the change aligns with the project's direction
9+
- Avoid duplicate or conflicting work
10+
- Provide guidance on implementation approach
11+
12+
We're friendly and responsive—don't hesitate to reach out!
13+
14+
## Commit and PR linting
415
We require pull request titles to follow the Conventional Commits specification and we also encourage individual commits to adher to that.
516

617
We use "squash merge" and any merge PR title will show up in the changelog based on the title.
718

8-
### Testing
19+
## Testing
920
We ask you to write well covered unit tests with your changes. To run tests:
1021
```shell
1122
mvn verify
1223
```
1324
As part of the CI pipeline, tests will run on java version 11 and 17.
1425

15-
### Formatting
26+
## Formatting
1627

1728
Please make sure you format your code according to [google-java-format](https://github.com/google/google-java-format) before making a PR.
1829
There are CI checks using [fmt](https://github.com/spotify/fmt-maven-plugin) that will fail otherwise.
@@ -22,19 +33,19 @@ You can use `fmt` to format your code using:
2233
mvn com.spotify.fmt:fmt-maven-plugin:format
2334
```
2435

25-
### Signing
36+
## Signing
2637
Maven is configured to sign the generated artifacts using GPG. This is a security measure required for uploading to Maven Central.
2738

2839
Signing passphrases are securely stored in Github's CI, but the signing operation is not needed when developing locally and can always
2940
be skipped via the argument `-Dgpg.skip`
3041

31-
### Releasing
42+
## Releasing
3243
Github Actions are set up that are able to:
3344
- Create automated PRs to manage new Github tags/releases
3445
- Manage versioning automatically (including the `pom.xml` file)
3546
- Upload the generated artifacts to Maven Central **Staging**
3647

3748
In order to promote an uploaded version from **Staging** to **Release** (hence making it openly available on [Maven Central Search](https://central.sonatype.com/)) a user with the right credentials must login into the the [Sonatype UI](https://oss.sonatype.org/#welcome) and perform the release process manually.
3849

39-
#### After realeasing
50+
### After realeasing
4051
After a release PR is merged, the main branch will stay at the release version (non-snapshot) until updated. Release please will create a PR ([example](https://github.com/spotify/confidence-sdk-java/pull/55)) that does this "snapshot bump". The recommendation is to merge that PR directly when possible.

0 commit comments

Comments
 (0)