chore: add publishing steps in readme

This commit is contained in:
Faris Ansari 2022-01-17 16:04:43 +05:30
parent 4cf30c6630
commit 9d01fa85b7

View File

@ -55,18 +55,44 @@ var gantt = new Gantt("#gantt", tasks, {
bar_corner_radius: 3,
arrow_curve: 5,
padding: 18,
view_mode: 'Day',
view_mode: 'Day',
date_format: 'YYYY-MM-DD',
custom_popup_html: null
});
```
If you want to contribute:
### Contributing
If you want to contribute enhancements or fixes:
1. Clone this repo.
2. `cd` into project directory
3. `yarn`
4. `yarn run dev`
5. Open `index.html` in your browser, make your code changes and test them.
### Publishing
If you have publishing rights (Frappe Team), follow these steps to publish a new version.
Assuming the last commit (or a couple of commits) were enhancements or fixes,
1. Run `yarn build`
This will generate files in the `dist/` folder. These files need to be committed.
1. Run `yarn publish`
1. Type the new version at the prompt
Depending on the type of change, you can either bump the patch version or the minor version.
For e.g.,
```
0.5.0 -> 0.6.0 (minor version bump)
0.5.0 -> 0.5.1 (patch version bump)
```
1. Now, there will be a commit named after the version you just entered. Include the generated files in `dist/` folder as part of this commit by running the command:
```
git add dist
git commit --amend
git push origin master
```
License: MIT