The following is a set of guidelines for contributing to Vue Design System. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
- When contributing, please first discuss the change(s) you wish to make via an issue with Vue Design System team.
- In most cases, we should be extending existing components instead of creating new ones. You might find this diagram useful.
- If you really need to add a new component, please review example component first. It shows you how to structure and document your component.
- If you wonder whether you should create an Element or a Pattern, ask yourself: “can this be broken down into smaller pieces?” If the answer is yes, there’s a high chance that it should be a Pattern instead of an Element. For a more thorough explanation, see terminology.
- Components in the system are labelled with status labels that reflect their state of completion. Make sure to update the status on any component you work on. See an example.
- Finally, when you’re done, submit your pull request and ask someone from Vue Design System team to review it.