You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+45-8Lines changed: 45 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -17,18 +17,16 @@ We'd also love PRs. If you're thinking of a large PR, we advise opening up an is
17
17
18
18
## Submitting a pull request
19
19
20
-
1.[Fork][fork] and clone the repository.
20
+
0.[Fork][fork] and clone the repository.
21
21
1. Configure and install the dependencies: `npm install`.
22
-
1. Run development: `npm run dev`. This step will install a temporary local vue-data-ui package and launch the testing arena.
23
-
1. Make sure the tests pass on your machine: `npm run test` and `npm run test:e2e`.
24
-
1. Create a new branch: `git checkout -b my-branch-name`.
25
-
1. Make your change, add tests, and make sure the tests still pass by running `npm run prod`.
26
-
1. Push to your fork and [submit a pull request][pr].
27
-
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
22
+
2.`npm run simple-build` will create the local dist
23
+
3. Run development: `npm run dev`. This step will install a temporary local vue-data-ui
24
+
4. Create a new branch: `git checkout -b my-branch-name`.
25
+
5. Make your change, add tests, and make sure the tests still pass by running `npm run prod`.
26
+
6. Push to your fork and [submit a pull request][pr].
28
27
29
28
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
30
29
31
-
- Follow the [style guide][style] which is using standard.
32
30
- Write and update tests.
33
31
- Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
34
32
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
@@ -45,3 +43,42 @@ Work in Progress pull requests are also welcome to get feedback early on, or if
45
43
-[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
All components of the library use a configuration object holding default values, allowing the user to provide the config prop with only the attributes they need to tweak.
52
+
53
+
If a feature requires additional default configuration:
54
+
55
+
1. update the `useConfig.js` file
56
+
2. update the types in `vue-data-ui.d.ts` file
57
+
3. update the testing arena with the new config items
58
+
59
+
### Adding slots, emits, exposed methods
60
+
61
+
When adding features involving slots, emits or exposed methods, please update the README file under the components section.
62
+
63
+
### Updating the vue-data-ui universal component
64
+
65
+
The VueDataUi universal component can be the sole component imported by users. It will async import the selected component, making a lighter use of the library.
66
+
67
+
If a feature added in a component requires the addition of a new emit or a new exposed method, they need to be referenced in the vue-data-ui.vue component.
68
+
69
+
### Updating the testing arena
70
+
71
+
The testing arena provides a quick way to visually test changes made on components, and toggle inputs to test configs.
72
+
`npm run dev` starts the dev server and serves a page where components are listed (App.vue).
73
+
74
+
The page shows either 4 or 5 versions of the tested component:
75
+
76
+
1. responsive version (if applicable) in a resizable container
77
+
2. local component
78
+
3. local VueDataUi component
79
+
4. build component
80
+
5. build VueDataUi component
81
+
82
+
All versions 2 to 5 must be identical after running `npm run prod` then `npm run dev`
83
+
84
+
The testing arena is pretty raw in terms of layout. Feel free to make it better ;)
0 commit comments