-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0f9a71a
commit 1a98a71
Showing
2 changed files
with
39 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,19 @@ | ||
| # Contributing to CoCreate-pass | ||
| # Contributing to CoCreate-state | ||
|
|
||
| This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-pass/graphs/contributors). | ||
| You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-pass/pulls), | ||
| [propose features and discuss issues](https://github.com/CoCreate-app/CoCreate-pass/issues). | ||
| This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-state/graphs/contributors). | ||
| You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-state/pulls), | ||
| [propose features and discuss issues](https://github.com/CoCreate-app/CoCreate-state/issues). | ||
|
|
||
| In the examples below, substitute your Github username for `contributor` in URLs. | ||
|
|
||
| ## Fork the Project | ||
|
|
||
| Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-pass) and check out your copy. | ||
| Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-state) and check out your copy. | ||
|
|
||
| ``` | ||
| git pass https://github.com/contributor/CoCreate-pass.git | ||
| cd CoCreate-pass | ||
| git remote add upstream https://github.com/CoCreate-app/CoCreate-pass.git | ||
| git state https://github.com/contributor/CoCreate-state.git | ||
| cd CoCreate-state | ||
| git remote add upstream https://github.com/CoCreate-app/CoCreate-state.git | ||
| ``` | ||
|
|
||
| ## Create a Topic Branch | ||
|
|
@@ -50,7 +50,7 @@ git config --global user.email "[email protected]" | |
| ``` | ||
|
|
||
| We use [semantic-release](https://github.com/semantic-release/semantic-release) as process to generate changelog | ||
| and to release. Write meaningful commits according to | ||
| and to release. Write meaningful commits according to | ||
| [Commit Message Formats](https://github.com/semantic-release/semantic-release#commit-message-format) is important. | ||
|
|
||
| ``` | ||
|
|
@@ -66,7 +66,6 @@ Here is an example of the release type that should be done based on a [semantic- | |
| | `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release | | ||
| | `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release | | ||
|
|
||
|
|
||
| ## Push | ||
|
|
||
| ``` | ||
|
|
@@ -75,7 +74,7 @@ git push origin my-feature-branch | |
|
|
||
| ## Make a Pull Request | ||
|
|
||
| Go to [https://github.com/CoCreate-app/CoCreate-pass](https://github.com/CoCreate-app/CoCreate-pass) and select your feature branch. | ||
| Go to [https://github.com/CoCreate-app/CoCreate-state](https://github.com/CoCreate-app/CoCreate-state) and select your feature branch. | ||
| Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days. | ||
|
|
||
| ## Rebase | ||
|
|
@@ -94,4 +93,4 @@ It's likely that your change will not be merged and that the nitpicky maintainer | |
|
|
||
| ## Thank You | ||
|
|
||
| Please do know that we really appreciate and value your time and work. We love you, really. | ||
| Please do know that we really appreciate and value your time and work. We love you, really. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,85 @@ | ||
| # CoCreate-pass | ||
| # CoCreate-state | ||
|
|
||
| Data attributes which can be used for components in CoCreate framework combined as a group of attributes that dynamically change attributes & fetch custom data. Take it for a spin in our [playground!](https://cocreate.app/docs/pass) | ||
| Data attributes which can be used for components in CoCreate framework combined as a group of attributes that dynamically change attributes & fetch custom data. Take it for a spin in our [playground!](https://cocreate.app/docs/state) | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## [Docs & Demo](https://cocreate.app/docs/pass) | ||
| ## [Docs & Demo](https://cocreate.app/docs/state) | ||
|
|
||
| For a complete guide and working demo refer to the [doumentation](https://cocreate.app/docs/pass) | ||
| For a complete guide and working demo refer to the [doumentation](https://cocreate.app/docs/state) | ||
|
|
||
| ## CDN | ||
|
|
||
| ```html | ||
| <script src="https://cdn.cocreate.app/pass/latest/CoCreate-pass.min.js"></script> | ||
| <script src="https://cdn.cocreate.app/state/latest/CoCreate-state.min.js"></script> | ||
| ``` | ||
|
|
||
| ```html | ||
| <script src="https://cdn.cocreate.app/pass/latest/CoCreate-pass.min.css"></script> | ||
| <script src="https://cdn.cocreate.app/state/latest/CoCreate-state.min.css"></script> | ||
| ``` | ||
|
|
||
| ## NPM | ||
|
|
||
| ```shell | ||
| $ npm i @cocreate/pass | ||
| $ npm i @cocreate/state | ||
| ``` | ||
|
|
||
| ## yarn | ||
|
|
||
| ```shell | ||
| $ yarn install @cocreate/pass | ||
| $ yarn install @cocreate/state | ||
| ``` | ||
|
|
||
| # Table of Contents | ||
|
|
||
| - [Table of Contents](#table-of-contents) | ||
| - [Announcements](#announcements) | ||
| - [Roadmap](#roadmap) | ||
| - [How to Contribute](#how-to-contribute) | ||
| - [About](#about) | ||
| - [License](#license) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Announcements](#announcements) | ||
| - [Roadmap](#roadmap) | ||
| - [How to Contribute](#how-to-contribute) | ||
| - [About](#about) | ||
| - [License](#license) | ||
|
|
||
| <a name="announcements"></a> | ||
|
|
||
| # Announcements | ||
|
|
||
| All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-pass/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-pass/releases). You may also subscribe to email for releases and breaking changes. | ||
| All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-state/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-state/releases). You may also subscribe to email for releases and breaking changes. | ||
|
|
||
| <a name="roadmap"></a> | ||
|
|
||
| # Roadmap | ||
|
|
||
| If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/CoCreate-app/CoCreate-pass/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-pass/pulls). We would love to hear your feedback. | ||
| If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/CoCreate-app/CoCreate-state/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-state/pulls). We would love to hear your feedback. | ||
|
|
||
| <a name="about"></a> | ||
|
|
||
| # About | ||
|
|
||
| CoCreate-pass is guided and supported by the CoCreate Developer Experience Team. | ||
| CoCreate-state is guided and supported by the CoCreate Developer Experience Team. | ||
|
|
||
| Please Email the Developer Experience Team [here](mailto:[email protected]) in case of any queries. | ||
|
|
||
| CoCreate-pass is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC. | ||
| CoCreate-state is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC. | ||
|
|
||
| <a name="contribute"></a> | ||
|
|
||
| # How to Contribute | ||
|
|
||
| We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreate-app/CoCreate-pass/blob/master/CONTRIBUTING.md) guide for details. | ||
| We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreate-app/CoCreate-state/blob/master/CONTRIBUTING.md) guide for details. | ||
|
|
||
| We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/CoCreate-pass/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-pass/pulls) or merely upvote or comment on existing issues or pull requests. | ||
| We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/CoCreate-state/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-state/pulls) or merely upvote or comment on existing issues or pull requests. | ||
|
|
||
| We appreciate your continued support, thank you! | ||
|
|
||
|
|
||
| <a name="license"></a> | ||
|
|
||
| # License | ||
|
|
||
| [The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-pass/blob/master/LICENSE) | ||
| [The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-state/blob/master/LICENSE) |