From 3694b6d612d1c603ce215982e72dc5ab67c67513 Mon Sep 17 00:00:00 2001 From: Cal Courtney Date: Fri, 31 May 2024 14:46:28 +0100 Subject: [PATCH] chore: update readme documentation --- .github/pull_request_template.md | 49 ++++++++ CONTRIBUTING.md | 76 ++++++++---- LICENSE | 203 +++++++++++++++++++++++++++++++ README.md | 90 +++++++++++--- 4 files changed, 375 insertions(+), 43 deletions(-) create mode 100644 .github/pull_request_template.md create mode 100644 LICENSE diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..ae47930 --- /dev/null +++ b/.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 React SDK! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44e2266..66bdbf0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,41 +1,67 @@ -# Contributing to the A/B Smartly JavaScript SDK +# Contributing to the ABsmartly React SDK -The A/B Smartly JavaScript 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 React 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 -For widespread use of the SDK with different environments and module formats, we have these different builds: +The SDK supports different environments and module formats. The available +builds are: -- An ESM build -- A **CommonJS** modules compatible build. +- ESM build +- CommonJS modules compatible build -The different builds can be generated all at once with the command `npm run build`. Refer to [package.json](package.json) for more insight on the build scripts. +Generate all builds with the command: -### Running tests +```bash +npm run build +``` -The project includes unit tests for both browser and Node.js environments. +Refer to the [package.json](package.json) file for more details on the build scripts. -All tests can be run at once with the command `npm run test`. +### Running Tests -For additional testing scripts or to get more insight on how these work, please refer to our [package.json](package.json) file. +The project includes unit tests for both client and server-side environments. +Run all tests with the command: -# Contact +```bash +npm run test +``` -If you have any other questions or need to contact us directly we can be reached at sdk@absmartly.com +For additional testing scripts and more information on how they work, refer to +the [package.json](package.json) file. + +## Contact + +If you have any questions or need further assistance, you can reach us at + or on your company's dedicated ABsmartly Slack Connect +channel. + +--- + +Thank you for contributing to the ABsmartly React SDK! Your efforts help us +improve and grow our open-source community. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a023308 --- /dev/null +++ b/LICENSE @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + 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. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md index a37bd37..2220782 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,89 @@ -# A/B Smartly React SDK [![npm version](https://badge.fury.io/js/%40absmartly%2Freact-sdk.svg)](https://badge.fury.io/js/%40absmartly%2Freact-sdk) + +

+ ABsmartly logo +

-A/B Smartly - React SDK +# ABsmartly React SDK -## Compatibility +[![NPM Downloads](https://img.shields.io/npm/dm/%40absmartly%2Freact-sdk)](https://www.npmjs.com/package/@absmartly/react-sdk) +[![NPM License](https://img.shields.io/npm/l/%40absmartly%2Freact-sdk)](https://www.npmjs.com/package/@absmartly/react-sdk) +[![NPM Version](https://img.shields.io/npm/v/%40absmartly%2Freact-sdk)](https://www.npmjs.com/package/@absmartly/react-sdk) +[![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40absmartly%2Freact-sdk)](https://bundlephobia.com/package/@absmartly/react-sdk@1.4.1) +[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/absmartly/react-sdk/build.yml)](https://github.com/absmartly/react-sdk/actions/workflows/build.yml) -The A/B Smartly React SDK is a thin wrapper around the [A/B Smartly JavaScript SDK](https://www.github.com/absmartly/javascript-sdk) +Welcome to the React SDK from ABsmartly! This SDK allows you to integrate +Feature Flagging and A/B testing seamlessly into your applications. + +## Table of Contents + +- [About ABsmartly](#about-absmartly) +- [Installation](#installation) + - [npm](#npm) + - [yarn](#yarn) + - [pnpm](#pnpm) +- [Usage](#usage) +- [Contributing](#contributing) +- [License](#license) +- [Support](#support) + +## About ABsmartly + +ABsmartly is a platform that enables you to run A/B tests across your +applications to optimize and improve user experiences. For more information +about our platform and services, please visit our +[website](https://www.absmartly.com) to request a demo. ## Installation -#### npm +To install the React SDK, simply use the following snippet: -```shell +### npm + +```bash npm install @absmartly/react-sdk --save ``` -## Documentation +### yarn + +```bash +yarn add @absmartly/react-sdk +``` + +### pnpm + +```bash +pnpm add @absmartly/react-sdk +``` + +## Usage + +Comprehensive documentation for this SDK is available at +[docs.absmartly.com](https://docs.absmartly.com/docs/SDK-Documentation/getting-started). +There, you will find detailed guides, examples and API references to help you +get started. + +## Contributing + +We welcome contributions from the community and our customers! If you'd like to contribute, +read the [Contributing Guide](./CONTRIBUTING.md) for more information. -Documentation for the A/B Smartly React SDK can be found on [our docs site](https://docs.absmartly.com/docs/SDK%20Documentation/getting-started) +## License -#### Further info +This project is licensed under the Apache 2.0 license. See the +[LICENSE](./LICENSE) file for details. -Please refer to the [A/B Smartly JavaScript SDK](https://www.github.com/absmartly/javascript-sdk) for more details. +## Support -## About A/B Smartly +If you encounter any issues or have any questions, please reach out to us at +, open an issue on GitHub, or reach out to us on your +company's dedicated ABsmartly Slack Connect channel. -**A/B Smartly** is the leading provider of state-of-the-art, on-premises, full-stack experimentation platforms for engineering and product teams that want to confidently deploy features as fast as they can develop them. -A/B Smartly's real-time analytics helps engineering and product teams ensure that new features will improve the customer experience without breaking or degrading performance and/or business metrics. +--- -### Have a look at our growing list of clients and SDKs: +Happy Experimenting! -- [Java SDK](https://www.github.com/absmartly/java-sdk) -- [JavaScript SDK](https://www.github.com/absmartly/javascript-sdk) -- [Swift SDK](https://www.github.com/absmartly/swift-sdk) -- [Vue2 SDK](https://www.github.com/absmartly/vue2-sdk) +The ABsmartly Team