@@ -26,6 +26,26 @@ First of all, you must decide on what branch your changes will be based. If the
26
26
fully backward-compatible, you should base your changes on the latest stable branch.
27
27
Otherwise, you should base your changes on the ` master ` branch.
28
28
29
+ ### Installing the source version
30
+
31
+ To install the source version of API Platform Admin in your project and contribute a patch, run the following command:
32
+
33
+ # Link the source version of API Platform admin
34
+ $ cd ..
35
+ $ git clone [email protected] :api-platform/admin.git -b the-latest-stable-branch
36
+ $ cd admin
37
+ $ yarn link
38
+ $ cd ../yourpoject
39
+ $ yarn link api-platform-admin
40
+ # Use the React version of your project to build API Platform admin
41
+ $ cd node_modules/react
42
+ $ yarn link
43
+ $ cd ../../../admin
44
+ $ yarn link react
45
+ $ yarn watch
46
+
47
+ You can now hack in the cloned repository of ` api-platform-admin ` .
48
+
29
49
### Testing your changes
30
50
31
51
Before sending a Pull Request, make sure the tests pass correctly:
@@ -36,7 +56,7 @@ yarn test
36
56
37
57
### Matching coding standards
38
58
39
- The API Platform CRUD Generator project is inspired by the [ Airbnb JavaScript style guide] ( https://github.com/airbnb/javascript ) .
59
+ The API Platform Admin project is inspired by the [ Airbnb JavaScript style guide] ( https://github.com/airbnb/javascript ) .
40
60
But don't worry, you can fix CS issues automatically using [ ESLint] ( https://eslint.org/ ) tool:
41
61
42
62
``` bash
@@ -101,6 +121,28 @@ Now force push to update your PR:
101
121
git push --force
102
122
```
103
123
124
+ # Tag a new version (contributors only)
125
+
126
+ Always test before releasing a new one:
127
+
128
+ ```
129
+ yarn build
130
+ yarn test
131
+ yarn lint
132
+ ```
133
+
134
+ To fix linting errors, you can use ` yarn fix ` .
135
+
136
+ To release a new version:
137
+
138
+ ``` bash
139
+ yarn version # this creates a tag
140
+ git push
141
+ git push --tags
142
+ ```
143
+
144
+ Travis will then publish the version on npm.
145
+
104
146
# License and copyright attribution
105
147
106
148
When you open a Pull Request to the API Platform project, you agree to license your code under the [ MIT license] ( LICENSE )
0 commit comments