Skip to content
This repository has been archived by the owner on Jul 31, 2024. It is now read-only.

Commit

Permalink
monorepo Format code
Browse files Browse the repository at this point in the history
  • Loading branch information
NikhilVerma committed Oct 7, 2023
1 parent ae9e36e commit 464fb4d
Show file tree
Hide file tree
Showing 197 changed files with 10,990 additions and 10,660 deletions.
24 changes: 13 additions & 11 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

title: ""
labels: ""
assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
Expand All @@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
### Checklist for raising a PR

- [ ] Gone through UX documnetation for adding new features.
- [ ] All necessary unit tests covered.
- [ ] Required comments added for generating component manifest file? you can find details [here](https://custom-elements-manifest.open-wc.org/analyzer/getting-started/)
- [ ] Did you check the contributing doc?
- [ ] Did you check the existing issues for similar queries?


### Describe your PR


### Add additional question here

- [ ] `Yes`
- [ ] `No`
- [ ] `NA`
- [ ] `NA`
42 changes: 21 additions & 21 deletions .storybook/code-sandbox.js
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
import { getParameters } from "codesandbox/lib/api/define";

export function getCodeSandBoxUrl(story) {
const params = getParameters({
files: {
"index.js": {
content: `import "@cldcvr/flow-core";
const params = getParameters({
files: {
"index.js": {
content: `import "@cldcvr/flow-core";
import "@cldcvr/flow-system-icon";
document.getElementById("app").innerHTML =\`${story}\`
`,
isBinary: false,
},
"index.html": {
content: `<!DOCTYPE html>
isBinary: false
},
"index.html": {
content: `<!DOCTYPE html>
<html>
<head>
Expand All @@ -27,18 +27,18 @@ export function getCodeSandBoxUrl(story) {
</body>
</html>`,
isBinary: false,
},
"package.json": {
content: {
dependencies: {
"@cldcvr/flow-system-icon": "latest",
"@cldcvr/flow-core": "latest",
},
},
},
},
});
isBinary: false
},
"package.json": {
content: {
dependencies: {
"@cldcvr/flow-system-icon": "latest",
"@cldcvr/flow-core": "latest"
}
}
}
}
});

return `https://codesandbox.io/api/v1/sandboxes/define?parameters=${params}`;
return `https://codesandbox.io/api/v1/sandboxes/define?parameters=${params}`;
}
32 changes: 19 additions & 13 deletions ABOUT.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,40 @@
# Flow/flow-core

### Mission

# Flow aims to be the fastest way to go from prototype to implementation

Without comprimising on design quality and front-end developer experience.

Flow is a design system that consists of principles, patterns, guidelines, and processes to enable design at scale; without compromising on the developer experience and standards. It serves as a shared language between design and implementation.

## Benefits
* Framework agnostic - Flow will work with most modern JavaScript frameworks.
* Developer experience is a core value for Flow. Learn more here.
* Flow Figma and Flow front-end framework speak the same language.
* VScode intellisense plugin
* Slack community
* Create easy layouts with f-div
* Flow dependencies - you can pick and choose what packages are specifically required for your build.
* Flow bundles (coming soon)

- Framework agnostic - Flow will work with most modern JavaScript frameworks.
- Developer experience is a core value for Flow. Learn more here.
- Flow Figma and Flow front-end framework speak the same language.
- VScode intellisense plugin
- Slack community
- Create easy layouts with f-div
- Flow dependencies - you can pick and choose what packages are specifically required for your build.
- Flow bundles (coming soon)

# Values

Straight to it - this is an opinionated project. We share a handful of core beliefs and values around designing + building and we treat them as the basis for our decisions.

## Obvious
Flow as a design framework and front-end tooling needs to be simple, intuitive, and obvious to anyone using the framework. This includes naming conventions, props and values definitions, documentation, etc.

Flow as a design framework and front-end tooling needs to be simple, intuitive, and obvious to anyone using the framework. This includes naming conventions, props and values definitions, documentation, etc.

When it comes to property values, Flow works with a list of default property value names that are available for use. You can refer to (coming soon)

## Figma to FE
Everything for front-end implementation that is available in Flow is required to exist as a Figma document as well. The Figma component properties will be the same properties for the front-end developer. This allows for better design handover + developer experience.

If you are a developer thas a new contribution to Flow and do not have Figma experience/skills, you can write to [email protected] and someone from CloudCover’s design team will get in touch with you. Keep in mind that the designers are actively engaged in other products and a response/implementation might take a little time.
Everything for front-end implementation that is available in Flow is required to exist as a Figma document as well. The Figma component properties will be the same properties for the front-end developer. This allows for better design handover + developer experience.

If you are a developer thas a new contribution to Flow and do not have Figma experience/skills, you can write to [email protected] and someone from CloudCover’s design team will get in touch with you. Keep in mind that the designers are actively engaged in other products and a response/implementation might take a little time.

## Everything as dependencies

## Everything as dependencies
To keep everything lean and customizable, any new features should be created as dependencies to avoid bloat on the Flow core level. This allows for features to live on different streams and continuously develop/update without affecting the main core.
To keep everything lean and customizable, any new features should be created as dependencies to avoid bloat on the Flow core level. This allows for features to live on different streams and continuously develop/update without affecting the main core.
76 changes: 40 additions & 36 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Thank you for your interest in contributing! 🎉👍

Flow is a framework that is made up of multiple dependencies / templates. Visit the [about.md](https://github.com/cldcvr/flow-core/blob/main/ABOUT.md) on the [flow-core repo](https://github.com/cldcvr/flow-core/) to learn more.
Flow is a framework that is made up of multiple dependencies / templates. Visit the [about.md](https://github.com/cldcvr/flow-core/blob/main/ABOUT.md) on the [flow-core repo](https://github.com/cldcvr/flow-core/) to learn more.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the [owners](https://github.com/cldcvr/flow-core/blob/main/CODEOWNERS) of this repository before making a change. You can expect a response from a maintainer within a week. If you haven’t heard anything by then, write to [email protected].

Expand All @@ -14,48 +14,52 @@ The Flow core team will review all dependencies and template contributions. The

The contributed files should be licensed with a recognized OpenSource license.

You can collaborate by
* Reporting issues
* Fixing issues and bug
* Design and define new components
* Flow Documentation (including this doc)
You can collaborate by

- Reporting issues
- Fixing issues and bug
- Design and define new components
- Flow Documentation (including this doc)

### Reporting issues

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in the template.

* Use a clear and descriptive title for the issue to identify the problem.
* Mention which version of the repo
* Describe the exact steps which reproduce the problem in as many details as possible.
* Explain which behavior you expected to see instead and why.
* Include screenshots, animated GIFs or videos that clearly demonstrate the problem.
- Use a clear and descriptive title for the issue to identify the problem.
- Mention which version of the repo
- Describe the exact steps which reproduce the problem in as many details as possible.
- Explain which behavior you expected to see instead and why.
- Include screenshots, animated GIFs or videos that clearly demonstrate the problem.

### Fixing issues

All issues as tracked here. Once you have resolved an issue,

* Verify that core values have been followed
* Flow color tokens have been consumed and no custom tokens have been created.
* Create a pull request in this repository by uploading your dependency package.
* In the PR description link to the respective figma page/file
* Include screenshots, animated GIFs or videos of the feature, you can also send it to [email protected] with a reference to the PR.
- Verify that core values have been followed
- Flow color tokens have been consumed and no custom tokens have been created.
- Create a pull request in this repository by uploading your dependency package.
- In the PR description link to the respective figma page/file
- Include screenshots, animated GIFs or videos of the feature, you can also send it to [email protected] with a reference to the PR.

### Design and define new components
* Guidelines coming soon
* Roadmap coming soon

- Guidelines coming soon
- Roadmap coming soon

### Flow Documentation
* Guidlines coming soon
* If you would like to contribute to this document and guidlines, write into [email protected]

- Guidlines coming soon
- If you would like to contribute to this document and guidlines, write into [email protected]

## Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the README.md with details of changes to the interface, this includes new environment
2. Update the README.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.

## Code of Conduct
Expand All @@ -74,21 +78,21 @@ orientation.
Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

### Flow core team responsibilities
Expand All @@ -97,7 +101,7 @@ Core team members are responsible for clarifying the standards of acceptable beh

Core team members have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

This documented was inspired by the contributing guidelines for penpot, atom, github
This documented was inspired by the contributing guidelines for penpot, atom, github

### Scope

Expand Down Expand Up @@ -127,4 +131,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
[version]: http://contributor-covenant.org/version/1/4/
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Paste the below snippet _after the closing `<template>`_ in your `App.vue`

```html
<style>
@import "@cldcvr/flow-core/dist/style.css";
@import "@cldcvr/flow-core/dist/style.css";
</style>
```

Expand Down Expand Up @@ -131,7 +131,7 @@ npm i --save @cldcvr/flow-system-icon

```javascript
Promise.all([import("@cldcvr/flow-core"), import("@cldcvr/flow-system-icon")]).then(() => {
// add your application startup code here
// add your application startup code here
});
```

Expand Down
10 changes: 5 additions & 5 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

Thank you for using Flow Lineage, an open source project hosted on GitHub. We appreciate your interest and support in our project. This support.md file is designed to provide you with information on how to get support for Flow Lineage.
Thank you for using Flow Lineage, an open source project hosted on GitHub. We appreciate your interest and support in our project. This support.md file is designed to provide you with information on how to get support for Flow Lineage.

## Where to Get Support

Expand All @@ -11,8 +10,8 @@ There are several avenues available to you for obtaining support for Flow Lineag

**Email:** If you prefer to contact us directly, you can send an email to [email protected] . Please provide a detailed description of your issue or question, along with any relevant information, and we will get back to you as soon as possible.


## How to Request Support

When seeking support for Flow Lineage, please follow these best practices:

**Be Specific:** Provide a clear and concise description of your issue or question. Include relevant details such as the steps you've taken, error messages, and the version of Flow Lineage you're using.
Expand All @@ -21,9 +20,10 @@ When seeking support for Flow Lineage, please follow these best practices:

**Include Relevant Information:** When submitting an issue or support request, please include all relevant information, such as your operating system, programming language version, and any other relevant software or hardware details. This will help us better understand your issue and provide a more accurate response.

**Be Patient:** The Flow team works diligently to respond to support requests as quickly as possible.
**Be Patient:** The Flow team works diligently to respond to support requests as quickly as possible.

**Be Respectful:** We strive to maintain a friendly and inclusive community. When seeking support, please be respectful to other users and project contributors. Avoid using offensive language or making derogatory comments.

## Contributing to Flow Lineage
If you're interested in contributing to Flow Lineage, we welcome your contributions. Please refer to our contribution guidelines, which can be found in the project's CONTRIBUTING.md on GitHub, for instructions on how to contribute.

If you're interested in contributing to Flow Lineage, we welcome your contributions. Please refer to our contribution guidelines, which can be found in the project's CONTRIBUTING.md on GitHub, for instructions on how to contribute.
Loading

0 comments on commit 464fb4d

Please sign in to comment.