chore: update markdown documentation

.github/pull_request_template.md

@@ -0,0 +1,49 @@
+# Pull Request Template
+
+## Description
+
+Please include a summary of the changes and the related issue. Explain the
+motivation for the change and how it addresses the issue. Provide context if necessary.
+
+Fixes # (issue)
+
+## Type of Change
+
+Please delete options that are not relevant and add any that are.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to
+  not work as expected)
+- [ ] Documentation update
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide
+instructions so we can reproduce. Include any relevant details for your test configuration.
+
+- [ ] Test A
+- [ ] Test B
+
+## Screenshots (if applicable)
+
+If your changes include UI updates to the docs or other applicable repos, please
+provide screenshots or GIFs to demonstrate the changes.
+
+## Additional Information
+
+Please add any other information that you think might be useful for the reviewer
+to know while reviewing this PR.
+
+Thank you for contributing to the ABsmartly Java SDK!

CONTRIBUTING.md

@@ -1,47 +1,64 @@
-# Contributing to the A/B Smartly Java SDK
+# Contributing to the ABsmartly Java SDK
 
-The A/B Smartly Java SDK is an open source project and we welcome your feedback and contributions.
-The information below describes how to build and test the project, and how to submit a pull request.
+The ABsmartly Java SDK is an open-source project, and we welcome your
+feedback and contributions. This guide provides information on how to build
+and test the project, and how to submit a pull request.
 
 ## Development
 
-### Development process
+### Development Process
 
-1. Fork the repository and create a topic branch from `main` branch. Please use a descriptive name for your branch.
-2. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like: "fix bug".
-3. Make sure to add tests for both positive and negative cases.
-4. Run the linter script of the project and fix any issues you find.
-5. Run the build script and make sure it runs with no errors.
-6. Run all tests and make sure there are no failures.
-7. `git push` your changes to GitHub within your topic branch.
-8. Open a Pull Request from your forked repo and into the `main` branch of the original repository.
-9. When creating your PR, please fill out all the fields of the PR template, as applicable, for the project.
-10. Check for conflicts once the pull request is created to make sure your PR can be merged cleanly into `main`.
-11. Keep an eye out for any feedback or comments from A/B Smartly's SDK team.
+1. **Fork and Branch**: Fork the repository and create a topic branch from the
+   `main` branch. Use a descriptive name for your branch.
+2. **Commit Messages**: Use descriptive commit messages. Avoid short or vague
+   messages like "fix bug".
+3. **Testing**: Add tests for both positive and negative cases to ensure
+   comprehensive coverage.
+4. **Linting**: Run the linter script and fix any issues. This helps maintain
+   code quality and consistency.
+5. **Building**: Run the build script to ensure it completes without errors.
+6. **Testing**: Run all tests to ensure there are no failures.
+7. **Push Changes**: Push your changes to GitHub in your topic branch.
+8. **Pull Request**: Open a pull request from your forked repo into the `main`
+   branch of the original repository.
+9. **PR Template**: Fill out all applicable fields in the pull request template.
+10. **Conflict Check**: Ensure there are no conflicts with the `main` branch
+    when creating the pull request.
+11. **Feedback**: Monitor your pull request for any feedback or comments from
+    the ABsmartly SDK team.
 
 ### Building the SDK
 
-```
+```bash
 ./gradlew build
 ```
 
-### Running tests
+### Running Tests
 
 The project includes unit tests.
 
 All tests can be run at once with the following command:
 
-```
+```bash
 ./gradlew test
 ```
 
-### Formatting and static analysis checks
+### Formatting and Static Analysis
 
-You can run all formatting and static analysis checks at once with the following command:
-```
+You can run all formatting and static analysis checks at once with the following
+command:
+
+```bash
 ./gradlew check
 ```
 
-# Contact
+## Contact
+
+If you have any questions or need further assistance, you can reach us at
+<[email protected]> or on your company's dedicated ABsmartly Slack Connect
+channel.
+
+---
 
-If you have any other questions or need to contact us directly we can be reached at [email protected]
+Thank you for contributing to the ABsmartly Java SDK! Your efforts help us
+improve and grow our open-source community.

LICENSE

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -186,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2024 ABsmartly
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.