Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the README so components and patterns are described. #6

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

waltertamboer
Copy link
Contributor

This PR updates the README so that the difference between components and patterns is more clear.

Copy link
Contributor

@renstah renstah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some typos, but other than that good


## Why?

We are sure that we are solving the same UX/UI problems every day. Sometimes these problems relate to basic patterns
and other times they are more complex. Therefor we believe in a library like this to describe these problems
so we are able to recognize them and choose for an existing implementation before writing our own.
and other times they are more complex. Therefor we believe in a library, like this, to describe these problems so we
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double comma's in this sentence reads a bit strange. I think the comma after libray is obsolete,

on the [template] in this repository. You can create a PR with the new file in the
proposed directory. The file **MUST** be named with the name of your pattern.
To create a new proposal fork this repository and create a new markdown file based on the [template] in this
repository. You can create a PR with the new file in the proposed directory. The file **MUST** be named with the name
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is better to rename PR to Pull Request, not all the users that are going to cooperate are technical users or github users.


After your PR was accepted the proposed pattern will be moved to the accepted
directory by one of the owners.
After your PR was accepted the proposed pattern will be moved to the accepted directory by one of the owners.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'was' needs to be 'is' and after accepted there needs to be a comma.

@waltertamboer
Copy link
Contributor Author

Thanks @renstah Updated the README with your suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants