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: .github/PULL_REQUEST_TEMPLATE.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,31 +1,30 @@
1
-
### Related issues
1
+
### Related Issues
2
2
<!-- Put related issue number which this PR is closing. For example #123 -->
3
3
4
4
closes #
5
5
6
-
### Short description and why it's useful
6
+
### Short Description and Why It's Useful
7
7
<!-- describe in a few words what is this Pull Request changing and why it's useful -->
8
8
9
9
10
10
11
-
### Screenshots of visual changes before/after (if there are any)
11
+
### Screenshots of Visual Changes before/after (if There Are Any)
12
12
<!-- if you made any changes in the UI layer please provide before/after screenshots -->
13
13
14
-
### Which environment this relates to
14
+
### Which Environment This Relates To
15
15
Check your case. In case of any doubts please read about [Release Cycle](https://docs.vuestorefront.io/guide/basics/release-cycle.html)
16
16
17
17
-[ ] Test version (https://test.storefrontcloud.io) - this is a new feature or improvement for Vue Storefront. I've created branch from `develop` branch and want to merge it back to `develop`
18
18
-[ ] RC version (https://next.storefrontcloud.io) - this is a stabilisation fix for Release Candidate of Vue Storefront. I've created branch from `release` branch and want to merge it back to `release`
19
19
-[ ] Stable version (https://demo.storefrontcloud.io) - this is an important fix for current stable version. I've created branch from `hotfix` or `master` branch and want to merge it back to `hotfix`
20
20
21
21
### Upgrade Notes and Changelog
22
-
23
22
-[x] No upgrade steps required (100% backward compatibility and no breaking changes)
24
-
-[ ] I've updated the [Upgrade notes](https://github.com/DivanteLtd/vue-storefront/blob/develop/docs/guide/upgrade-notes/README.md) and [Changelog](https://github.com/DivanteLtd/vue-storefront/blob/develop/CHANGELOG.md) on how to port existing VS sites with this new feature
23
+
-[ ] I've updated the [Upgrade notes](https://github.com/DivanteLtd/vue-storefront/blob/develop/docs/guide/upgrade-notes/README.md) and [Changelog](https://github.com/DivanteLtd/vue-storefront/blob/develop/CHANGELOG.md) on how to port existing Vue Storefront sites with this new feature
25
24
26
25
**IMPORTANT NOTICE** - Remember to update `CHANGELOG.md` with description of your change
27
26
28
-
### Contribution and currently important rules acceptance
27
+
### Contribution and Currently Important Rules Acceptance
29
28
<!-- Please get familiar with following info -->
30
29
31
30
-[ ] I read and followed [contribution rules](https://github.com/DivanteLtd/vue-storefront/blob/master/CONTRIBUTING.md)
Already a JS/Vue.js developer? Pick an issue, push a PR and instantly become a member of the vue-storefront contributors community.
3
+
Already a JavaScript/Vue.js developer? Pick an issue, push a pull request (PR) and instantly become a member of the vue-storefront contributors community.
4
4
We've marked some issues as "Easy first pick" to make it easier for newcomers to begin!
5
5
6
6
Thank you for your interest in, and engagement!
7
7
8
-
Before you type an issue please read about out [release lifecycle](https://docs.vuestorefront.io/guide/basics/release-cycle.html)
8
+
Before you type an issue please read about out [release lifecycle](https://docs.vuestorefront.io/guide/basics/release-cycle.html).
9
9
10
10
# Branches
11
11
@@ -18,41 +18,39 @@ The main branches used by the core team are:
18
18
19
19
Please use "develop" or "RC" for development purposes as the "master" can be merged just as the new release is coming out (about once a month)!
20
20
21
-
## Issue reporting guidelines:
21
+
## Issue Reporting Guidelines
22
22
23
23
Always define the type of issue:
24
24
* Bug report
25
25
* Feature request
26
26
27
-
While writing issues, be as specific as possible
28
-
All requests regarding support with implementation or application setup should be sent to [email protected]
27
+
While writing issues, be as specific as possible. All requests regarding support with implementation or application setup should be sent to [email protected].
29
28
30
-
**Tag your issues properly**. If you found a bug tag it with `bug` label. If you're requesting new feature tag it with `feature request` label.
29
+
**Tag your issues properly**. If you found a bug, tag it with `bug` label. If you're requesting new feature, tag it with `feature request` label.
31
30
32
-
## Git flow
33
-
We're introducing TypeScript to Vue Storefront core, so You can use it where it's appropriate - but please be pragmatic.
34
-
Here are some thoughts on how to use TS features in Vue Storefront: [TypeScript Action Plan](https://github.com/DivanteLtd/vue-storefront/blob/master/doc/TypeScript%20Action%20Plan.md).
31
+
## Git Flow
35
32
36
-
## Pull request Checklist
33
+
We're introducing TypeScript to Vue Storefront core, so you can use it where it's appropriate - but please be pragmatic.
34
+
Here are some thoughts on how to use TypeScript features in Vue Storefront: [TypeScript Action Plan](https://github.com/DivanteLtd/vue-storefront/blob/master/doc/TypeScript%20Action%20Plan.md).
37
35
38
-
Here’s how to submit a pull request. <b>Pull request that don't meet these requirements will not be merged.</b>
36
+
## Pull Request Checklist
39
37
40
38
**ALWAYS** use [Pull Request template](https://github.com/DivanteLtd/vue-storefront/blob/master/PULL_REQUEST_TEMPLATE.md) it's automatically added to each PR.
41
-
1. Fork the repository and clone it locally fro the 'develop' branch. Make sure it's up to date with current `develop` branch
39
+
1. Fork the repository and clone it locally from the 'develop' branch. Make sure it's up to date with current `develop` branch
42
40
2. Create a branch for your edits. Use the following branch naming conventions:
43
41
* bugfix/task-title
44
42
* feature/task-name
45
43
3. Use Pull Request template and fill as much fields as possible to describe your solution.
46
44
4. Reference any relevant issues or supporting documentation in your PR (ex. “Issue: 39. Issue title.”).
47
45
5. If you are adding new feature provide documentation along with the PR. Also, add it to [upgrade notes](https://github.com/DivanteLtd/vue-storefront/blob/master/doc/Upgrade%20notes.md)
48
46
6. If you are removing/renaming something or changing its behavior also include it in [upgrade notes](https://github.com/DivanteLtd/vue-storefront/blob/master/doc/Upgrade%20notes.md)
49
-
7. Test your changes! Run your changes against any existing tests and create new ones when needed. Make sure your changes don’t break the existing project. Make sure that your branch is passing Travis CI build.
47
+
7. Test your changes! Run your changes against any existing tests and create new ones when needed. Make sure your changes don’t break the existing project. Make sure that your branch is passing Travis CI build.
50
48
8. If you have found a potential security vulnerability, please DO NOT report it on the public issue tracker. Instead, send it to us at [email protected]. We will work with you to verify and fix it as soon as possible.
0 commit comments