|
1 |
| -# Contributing to the A/B Smartly Java SDK |
| 1 | +# Contributing to the ABsmartly Java SDK |
2 | 2 |
|
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. |
5 | 6 |
|
6 | 7 | ## Development
|
7 | 8 |
|
8 |
| -### Development process |
| 9 | +### Development Process |
9 | 10 |
|
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. |
21 | 29 |
|
22 | 30 | ### Building the SDK
|
23 | 31 |
|
24 |
| -``` |
| 32 | +```bash |
25 | 33 | ./gradlew build
|
26 | 34 | ```
|
27 | 35 |
|
28 |
| -### Running tests |
| 36 | +### Running Tests |
29 | 37 |
|
30 | 38 | The project includes unit tests.
|
31 | 39 |
|
32 | 40 | All tests can be run at once with the following command:
|
33 | 41 |
|
34 |
| -``` |
| 42 | +```bash |
35 | 43 | ./gradlew test
|
36 | 44 | ```
|
37 | 45 |
|
38 |
| -### Formatting and static analysis checks |
| 46 | +### Formatting and Static Analysis |
39 | 47 |
|
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 |
42 | 52 | ./gradlew check
|
43 | 53 | ```
|
44 | 54 |
|
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 | +--- |
46 | 62 |
|
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. |
0 commit comments