Skip to content

Commit

Permalink
update issues templates
Browse files Browse the repository at this point in the history
  • Loading branch information
nolimits4web committed Nov 7, 2022
1 parent 7d68a65 commit 2275839
Show file tree
Hide file tree
Showing 6 changed files with 72 additions and 44 deletions.
41 changes: 19 additions & 22 deletions .github/CONTRIBUTING.md
Expand Up @@ -2,42 +2,39 @@

Framework7 loves to welcome your contributions. There are several ways to help out:

* Create an [issue](https://github.com/framework7io/framework7/issues) on GitHub, if you have found a bug
* Write test cases or provide examples for open bug issues
* Write patches for open bug/feature issues, preferably with test cases included
* Contribute to the [documentation](https://github.com/framework7io/framework7-website)
- Create an [issue](https://github.com/framework7io/framework7/issues) on GitHub, if you have found a bug
- Write test cases or provide examples for open bug issues
- Write patches for open bug/feature issues, preferably with test cases included
- Contribute to the [documentation](https://github.com/framework7io/framework7-website)

There are a few guidelines that we need contributors to follow so that we have a
chance of keeping on top of things.


## Getting Started

* Make sure you have a [GitHub account](https://github.com/signup/free).
* Submit an [issue](https://github.com/framework7io/framework7/issues), assuming one does not already exist.
* Clearly describe the issue including steps to reproduce when it is a bug.
* Make sure you fill in the earliest version that you know has the issue.
* Include live link or JSFiddle/Codepen link with the issue if you want it to be discovered and resolved asap. We have one ready template for you: [JSFiddle](https://jsfiddle.net/nolimits4web/o2ejupu1/)
* Fork the repository on GitHub.
- Make sure you have a [GitHub account](https://github.com/signup/free).
- Submit an [issue](https://github.com/framework7io/framework7/issues), assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
- Include live link or CodeSandbox/Codepen link with the issue if you want it to be discovered and resolved asap. We have one ready template for you: [CodeSandbox](https://codesandbox.io/p/sandbox/tender-darwin-m72wt0?file=%2Fsrc%2Fjs%2Fapp.js)
- Fork the repository on GitHub.

## Making Changes

* Create a topic branch from where you want to base your work.
* This is usually the master branch.
* Only target release branches if you are certain your fix must be on that
- Create a topic branch from where you want to base your work.
- This is usually the master branch.
- Only target release branches if you are certain your fix must be on that
branch.
* To quickly create a topic branch based on master; `git branch
master/my_contribution master` then checkout the new branch with `git
checkout master/my_contribution`. Better avoid working directly on the
- To quickly create a topic branch based on master; `git branch master/my_contribution master` then checkout the new branch with `git checkout master/my_contribution`. Better avoid working directly on the
`master` branch, to avoid conflicts if you pull in updates from origin.
* Make commits of logical units.
* Check for unnecessary whitespace with `git diff --check` before committing.
* Use descriptive commit messages and reference the #issue number.
- Make commits of logical units.
- Check for unnecessary whitespace with `git diff --check` before committing.
- Use descriptive commit messages and reference the #issue number.

## Submitting Changes

* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the repository
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository

## Editor Config

Expand Down
13 changes: 10 additions & 3 deletions .github/ISSUE_TEMPLATE.md
Expand Up @@ -21,28 +21,35 @@ Please, don't ask questions on GitHub! Do you want to ask a question? Are you lo
- If the issue is related to Template7, then please open it in Template7 repository at https://github.com/nolimits4web/Template7
-->

* Framework7 version: [e.g. 3.0.0]
* Platform and Target: [e.g. iOS 11 Cordova app, or Android 8 Chrome browser]
* Live Link or JSFiddle: PREFERABLY _(IF YOU WANT YOUR ISSUE TO BE RESOLVED ASAP)_. You can start from forking the following JSFiddle template: [JSFiddle](https://jsfiddle.net/nolimits4web/o2ejupu1/)
- Framework7 version: [e.g. 3.0.0]
- Platform and Target: [e.g. iOS 11 Cordova app, or Android 8 Chrome browser]
- Live Link or CodeSandbox: PREFERABLY _(IF YOU WANT YOUR ISSUE TO BE RESOLVED ASAP)_. You can start from forking the following CodeSandbox template: [CodeSandbox](https://codesandbox.io/p/sandbox/tender-darwin-m72wt0?file=%2Fsrc%2Fjs%2Fapp.js)

### Describe the bug

A clear and concise description of what the bug is.

### To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behavior

A clear and concise description of what you expected to happen.

### Actual Behavior

Explain what is actually happening

### Screenshots

If applicable, add screenshots to help explain your problem.

### Additional context

Add any other context about the problem here.
14 changes: 10 additions & 4 deletions .github/ISSUE_TEMPLATE/framewor7-core-issue.md
@@ -1,7 +1,6 @@
---
name: Framework7-Core Issue
about: Create a report to help us improve

---

<!--
Expand All @@ -15,28 +14,35 @@ Please, don't ask questions on GitHub! Do you want to ask a question? Are you lo
- If the issue is related to Template7, then please open it in Template7 repository at https://github.com/nolimits4web/Template7
-->

* Framework7 version: [e.g. 3.0.0]
* Platform and Target: [e.g. iOS 11 Cordova app, or Android 8 Chrome browser]
* Live Link or JSFiddle: PREFERABLY _(IF YOU WANT YOUR ISSUE TO BE RESOLVED ASAP)_. You can start from forking the following JSFiddle template: [JSFiddle](https://jsfiddle.net/nolimits4web/o2ejupu1/)
- Framework7 version: [e.g. 3.0.0]
- Platform and Target: [e.g. iOS 11 Cordova app, or Android 8 Chrome browser]
- Live Link or CodeSandbox: PREFERABLY _(IF YOU WANT YOUR ISSUE TO BE RESOLVED ASAP)_. You can start from forking the following CodeSandbox template: [CodeSandbox](https://codesandbox.io/p/sandbox/tender-darwin-m72wt0?file=%2Fsrc%2Fjs%2Fapp.js)

### Describe the bug

A clear and concise description of what the bug is.

### To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behavior

A clear and concise description of what you expected to happen.

### Actual Behavior

Explain what is actually happening

### Screenshots

If applicable, add screenshots to help explain your problem.

### Additional context

Add any other context about the problem here.
16 changes: 11 additions & 5 deletions .github/ISSUE_TEMPLATE/framewor7-react-issue.md
@@ -1,7 +1,6 @@
---
name: Framework7-React Issue
about: Create a report to help us improve

---

<!--
Expand All @@ -15,29 +14,36 @@ Please, don't ask questions on GitHub! Do you want to ask a question? Are you lo
- If the issue is related to Template7, then please open it in Template7 repository at https://github.com/nolimits4web/Template7
-->

* Framework7 version: [e.g. 3.0.0]
* React.js version: [e.g. 16.0.0]
* Platform and Target: [e.g. iOS 11 Cordova app, or Android 8 Chrome browser]
* Live Link or JSFiddle: PREFERABLY _(IF YOU WANT YOUR ISSUE TO BE RESOLVED ASAP)_. You can start from forking the following JSFiddle template: [JSFiddle](https://jsfiddle.net/nolimits4web/vxb8oyke/)
- Framework7 version: [e.g. 3.0.0]
- React.js version: [e.g. 16.0.0]
- Platform and Target: [e.g. iOS 11 Cordova app, or Android 8 Chrome browser]
- Live Link or CodeSandbox: PREFERABLY _(IF YOU WANT YOUR ISSUE TO BE RESOLVED ASAP)_. You can start from forking the following CodeSandbox template: [CodeSandbox](https://codesandbox.io/p/sandbox/f7-react-vite-e6y55h?file=%2Fsrc%2Fjs%2Fapp.js)

### Describe the bug

A clear and concise description of what the bug is.

### To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behavior

A clear and concise description of what you expected to happen.

### Actual Behavior

Explain what is actually happening

### Screenshots

If applicable, add screenshots to help explain your problem.

### Additional context

Add any other context about the problem here.
16 changes: 11 additions & 5 deletions .github/ISSUE_TEMPLATE/framewor7-svelte-issue.md
@@ -1,7 +1,6 @@
---
name: Framework7-Svelte Issue
about: Create a report to help us improve

---

<!--
Expand All @@ -15,29 +14,36 @@ Please, don't ask questions on GitHub! Do you want to ask a question? Are you lo
- If the issue is related to Template7, then please open it in Template7 repository at https://github.com/nolimits4web/Template7
-->

* Framework7 version: [e.g. 3.0.0]
* Svelte version: [e.g. 3.0.0]
* Platform and Target: [e.g. iOS 11 Cordova app, or Android 8 Chrome browser]
* Live Link or JSFiddle/CodeSandbox: PREFERABLY _(IF YOU WANT YOUR ISSUE TO BE RESOLVED ASAP)_. You can start from forking the following CodeSandbox template: [CodeSandbox](https://codesandbox.io/s/framework7-svelte-yf8m2)
- Framework7 version: [e.g. 3.0.0]
- Svelte version: [e.g. 3.0.0]
- Platform and Target: [e.g. iOS 11 Cordova app, or Android 8 Chrome browser]
- Live Link or CodeSandbox/CodeSandbox: PREFERABLY _(IF YOU WANT YOUR ISSUE TO BE RESOLVED ASAP)_. You can start from forking the following CodeSandbox template: [CodeSandbox](https://codesandbox.io/p/sandbox/f7-svelte-vite-2gqwu4?file=%2Fsrc%2Fjs%2Fapp.js)

### Describe the bug

A clear and concise description of what the bug is.

### To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behavior

A clear and concise description of what you expected to happen.

### Actual Behavior

Explain what is actually happening

### Screenshots

If applicable, add screenshots to help explain your problem.

### Additional context

Add any other context about the problem here.
16 changes: 11 additions & 5 deletions .github/ISSUE_TEMPLATE/framewor7-vue-issue.md
@@ -1,7 +1,6 @@
---
name: Framework7-Vue Issue
about: Create a report to help us improve

---

<!--
Expand All @@ -15,29 +14,36 @@ Please, don't ask questions on GitHub! Do you want to ask a question? Are you lo
- If the issue is related to Template7, then please open it in Template7 repository at https://github.com/nolimits4web/Template7
-->

* Framework7 version: [e.g. 3.0.0]
* Vue.js version: [e.g. 2.0.0]
* Platform and Target: [e.g. iOS 11 Cordova app, or Android 8 Chrome browser]
* Live Link or JSFiddle: PREFERABLY _(IF YOU WANT YOUR ISSUE TO BE RESOLVED ASAP)_. You can start from forking the following JSFiddle template: [JSFiddle](https://jsfiddle.net/nolimits4web/jcwzqovz/)
- Framework7 version: [e.g. 3.0.0]
- Vue.js version: [e.g. 2.0.0]
- Platform and Target: [e.g. iOS 11 Cordova app, or Android 8 Chrome browser]
- Live Link or CodeSandbox: PREFERABLY _(IF YOU WANT YOUR ISSUE TO BE RESOLVED ASAP)_. You can start from forking the following CodeSandbox template: [CodeSandbox](https://codesandbox.io/p/sandbox/f7-vue-vite-eevfif?file=%2Fsrc%2Fjs%2Fapp.js)

### Describe the bug

A clear and concise description of what the bug is.

### To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behavior

A clear and concise description of what you expected to happen.

### Actual Behavior

Explain what is actually happening

### Screenshots

If applicable, add screenshots to help explain your problem.

### Additional context

Add any other context about the problem here.

0 comments on commit 2275839

Please sign in to comment.