Skip to content

Commit 320cfee

Browse files
committed
chore: update markdown documentation
1 parent f538b50 commit 320cfee

File tree

3 files changed

+97
-320
lines changed

3 files changed

+97
-320
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,64 @@
1-
# Contributing to the A/B Smartly Java SDK
1+
# Contributing to the ABsmartly Java SDK
22

3-
The A/B Smartly Java SDK is an open source project and we welcome your feedback and contributions.
4-
The information below describes how to build and test the project, and how to submit a pull request.
3+
The ABsmartly Java SDK is an open-source project, and we welcome your
4+
feedback and contributions. This guide provides information on how to build
5+
and test the project, and how to submit a pull request.
56

67
## Development
78

8-
### Development process
9+
### Development Process
910

10-
1. Fork the repository and create a topic branch from `main` branch. Please use a descriptive name for your branch.
11-
2. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like: "fix bug".
12-
3. Make sure to add tests for both positive and negative cases.
13-
4. Run the linter script of the project and fix any issues you find.
14-
5. Run the build script and make sure it runs with no errors.
15-
6. Run all tests and make sure there are no failures.
16-
7. `git push` your changes to GitHub within your topic branch.
17-
8. Open a Pull Request from your forked repo and into the `main` branch of the original repository.
18-
9. When creating your PR, please fill out all the fields of the PR template, as applicable, for the project.
19-
10. Check for conflicts once the pull request is created to make sure your PR can be merged cleanly into `main`.
20-
11. Keep an eye out for any feedback or comments from A/B Smartly's SDK team.
11+
1. **Fork and Branch**: Fork the repository and create a topic branch from the
12+
`main` branch. Use a descriptive name for your branch.
13+
2. **Commit Messages**: Use descriptive commit messages. Avoid short or vague
14+
messages like "fix bug".
15+
3. **Testing**: Add tests for both positive and negative cases to ensure
16+
comprehensive coverage.
17+
4. **Linting**: Run the linter script and fix any issues. This helps maintain
18+
code quality and consistency.
19+
5. **Building**: Run the build script to ensure it completes without errors.
20+
6. **Testing**: Run all tests to ensure there are no failures.
21+
7. **Push Changes**: Push your changes to GitHub in your topic branch.
22+
8. **Pull Request**: Open a pull request from your forked repo into the `main`
23+
branch of the original repository.
24+
9. **PR Template**: Fill out all applicable fields in the pull request template.
25+
10. **Conflict Check**: Ensure there are no conflicts with the `main` branch
26+
when creating the pull request.
27+
11. **Feedback**: Monitor your pull request for any feedback or comments from
28+
the ABsmartly SDK team.
2129

2230
### Building the SDK
2331

24-
```
32+
```bash
2533
./gradlew build
2634
```
2735

28-
### Running tests
36+
### Running Tests
2937

3038
The project includes unit tests.
3139

3240
All tests can be run at once with the following command:
3341

34-
```
42+
```bash
3543
./gradlew test
3644
```
3745

38-
### Formatting and static analysis checks
46+
### Formatting and Static Analysis
3947

40-
You can run all formatting and static analysis checks at once with the following command:
41-
```
48+
You can run all formatting and static analysis checks at once with the following
49+
command:
50+
51+
```bash
4252
./gradlew check
4353
```
4454

45-
# Contact
55+
## Contact
56+
57+
If you have any questions or need further assistance, you can reach us at
58+
<[email protected]> or on your company's dedicated ABsmartly Slack Connect
59+
channel.
60+
61+
---
4662

47-
If you have any other questions or need to contact us directly we can be reached at [email protected]
63+
Thank you for contributing to the ABsmartly Java SDK! Your efforts help us
64+
improve and grow our open-source community.

LICENSE

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
Apache License
23
Version 2.0, January 2004
34
http://www.apache.org/licenses/
@@ -186,7 +187,7 @@
186187
same "printed page" as the copyright notice for easier
187188
identification within third-party archives.
188189

189-
Copyright [yyyy] [name of copyright owner]
190+
Copyright 2024 ABsmartly
190191

191192
Licensed under the Apache License, Version 2.0 (the "License");
192193
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)