Skip to content

Commit 1dff5e1

Browse files
authored
docs: update github issue templates and contribution guide (#1914)
* refactor: remove code formattings config files * docs: add more detail to contribution guidelines * docs: remove custom templates * docs: update bug report issue * docs: add discussion template * docs: update featue template
1 parent a798fcf commit 1dff5e1

File tree

7 files changed

+146
-178
lines changed

7 files changed

+146
-178
lines changed

.editorconfig

Lines changed: 0 additions & 15 deletions
This file was deleted.
Lines changed: 22 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,48 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
4-
title: "[bug] "
3+
about: Document a bug with a working example
4+
title: ""
55
labels: ""
66
assignees: ""
77
---
88

9-
<!--
9+
_**[PLEASE READ THE CONTRIBUTION GUIDELINES HERE!](https://github.com/SortableJS/Sortable/tree/master/CONTRIBUTING.md)**_
1010

11-
PLEASE READ BEFORE POSTING YOUR ISSUE!
11+
_Failure to comply may have your issue automatically closed._
1212

13-
If your issue is related to a framework or @types/sortablejs,
14-
please post an issue on it's relevant repository instead:
13+
## Reproduction
1514

16-
- Angular
17-
- 2.0+: https://github.com/SortableJS/angular-sortablejs/issues
18-
- legacy: https://github.com/SortableJS/angular-legacy-sortablejs/issues
19-
- React
20-
- ES2015+: https://github.com/SortableJS/react-sortablejs/issues
21-
- mixin: https://github.com/SortableJS/react-mixin-sortablejs/issues
22-
- Polymer: https://github.com/SortableJS/polymer-sortablejs/issues
23-
- Knockout: https://github.com/SortableJS/knockout-sortablejs/issues
24-
- Meteor: https://github.com/SortableJS/meteor-sortablejs/issues
15+
<!-- Please select a codesandbox to start crafting -->
2516

17+
<!-- Javascript - https://codesandbox.io/s/sortablejs-javascript-jy3tl?file=/src/index.js -->
18+
<!-- Typescript - https://codesandbox.io/s/sortablejs-typescript-6it9n?file=/src/index.ts -->
2619

27-
If it is a bug found from using one of these, please link to the related issue.
20+
### Scenario
2821

29-
-->
22+
\<codesandbox-url-here\>
3023

31-
**Describe the bug**
24+
### Steps to Reproduce
3225

33-
<!-- A clear and concise description of what the bug is. -->
34-
35-
**To Reproduce**
36-
Steps to reproduce the behavior:
26+
Summary of steps if applicable.
3727

3828
1. Go to '...'
3929
2. Click on '....'
4030
3. Scroll down to '....'
4131
4. See error
4232

43-
**Expected behavior**
44-
45-
<!-- A clear and concise description of what you expected to happen. -->
46-
47-
**Information**
48-
49-
<!-- This is required. Issues without this critical information will be closed. -->
33+
## Describe the bug
5034

51-
Versions - Look in your `package.json` for this information:
52-
sortablejs = ^x.x.x
53-
@types/sortablejs = ^x.x.x
54-
55-
**Additional context**
56-
Add any other context about the problem here.
57-
58-
**Reproduction**
59-
codesandbox: <your_url_here>
60-
61-
<!--
35+
<!-- A clear and concise description of what the bug is. -->
6236

63-
Providing a codesandbox really helps us understand your issue.
64-
Bugs with codesandboxes attached are likely to be resolved more quickly than others.
37+
## Expected behavior
6538

66-
Once you've created a public codesandbox, please paste a link in here
39+
<!-- A clear and concise description of what you expected to happen. -->
6740

68-
Here are some templates to get you started.
41+
## Version
6942

70-
- Javascript: https://codesandbox.io/s/sortablejs-javascript-jy3tl?file=/src/index.js
71-
- Typescript: https://codesandbox.io/s/sortablejs-typescript-6it9n?file=/src/index.ts
43+
| package | version |
44+
| :------------------ | :------------------ |
45+
| `sortablejs` | `^x.x.x-?` |
46+
| `@types/sortablejs` | `^x.x.x-?` \|\| N/A |
7247

73-
-->
48+
## Additional Context

.github/ISSUE_TEMPLATE/custom-template.md

Lines changed: 0 additions & 48 deletions
This file was deleted.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Question/Feedback
3+
about: Ask the community a question or give us some feedback!
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
Please answer the following:
10+
11+
- What result are you trying to achieve and why?
12+
- Where are you getting stuck at?
13+
14+
## Reproduction
15+
16+
### Scenario
17+
18+
<!-- Please select a codesandbox to start crafting -->
19+
20+
<!-- Javascript - https://codesandbox.io/s/sortablejs-javascript-jy3tl?file=/src/index.js -->
21+
<!-- Typescript - https://codesandbox.io/s/sortablejs-typescript-6it9n?file=/src/index.ts -->
22+
23+
\<codesandbox-url-here\>
24+
25+
### Steps to Reproduce
26+
27+
Summary of steps if applicable.
28+
29+
1. Go to '...'
30+
2. Click on '....'
31+
3. Scroll down to '....'
32+
4. Looks good
33+
34+
## Version
35+
36+
| package | version |
37+
| :------------------ | :------------------ |
38+
| `sortablejs` | `^x.x.x-?` |
39+
| `@types/sortablejs` | `^x.x.x-?` \|\| N/A |

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,16 @@ labels: ""
66
assignees: ""
77
---
88

9-
<!--
9+
_**[PLEASE READ THE CONTRIBUTION GUIDELINES HERE!](https://github.com/SortableJS/Sortable/tree/master/CONTRIBUTING.md)**_
1010

11-
PLEASE READ BEFORE POSTING YOUR ISSUE!
11+
_Failure to comply may have your issue automatically closed._
1212

13-
If your issue is related to a framework or @types/sortablejs,
14-
please post an issue on it's relevant repository instead:
13+
## Summary
1514

16-
- Angular
17-
- 2.0+: https://github.com/SortableJS/angular-sortablejs/issues
18-
- legacy: https://github.com/SortableJS/angular-legacy-sortablejs/issues
19-
- React
20-
- ES2015+: https://github.com/SortableJS/react-sortablejs/issues
21-
- mixin: https://github.com/SortableJS/react-mixin-sortablejs/issues
22-
- Polymer: https://github.com/SortableJS/polymer-sortablejs/issues
23-
- Knockout: https://github.com/SortableJS/knockout-sortablejs/issues
24-
- Meteor: https://github.com/SortableJS/meteor-sortablejs/issues
15+
Please answer the following questions in sentences.
2516

17+
- What is the feature?
18+
- Why is having this feature important to you?
19+
- Who else will find having this feature helpful?
2620

27-
If it is a bug found from using one of these, please link to the related issue.
28-
29-
-->
30-
31-
**Is your feature request related to a problem? Please describe.**
32-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
33-
34-
**Describe the solution you'd like**
35-
A clear and concise description of what you want to happen.
36-
37-
**Describe alternatives you've considered**
38-
A clear and concise description of any alternative solutions or features you've considered.
39-
40-
**Additional context**
41-
Add any other context or screenshots about the feature request here.
21+
## Additional Context

.jshintrc

Lines changed: 0 additions & 25 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 77 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,88 @@
11
# Contribution Guidelines
22

3-
### Issue
3+
Thank you for considering to contribute. Please follow the guidelines.
4+
If the guidelines are not followed, your issues or requests may be closed or left on hold until the requirements are fulfilled.
45

5-
1. Try [master](https://github.com/SortableJS/Sortable/tree/master/)-branch, perhaps the problem has been solved;
6-
2. [Use the search](https://github.com/SortableJS/Sortable/search?type=Issues&q=problem), maybe already have an answer;
7-
3. If not found, create example on [jsbin.com (draft)](https://jsbin.com/kamiwez/edit?html,js,output) and describe the problem.
6+
---
7+
8+
## Manners and Etiquette 🎩
9+
10+
Please be thoughtful and considerate of others when posting any content within the sortable community. We do this for free, just like you.
11+
12+
Hate speech and non constructive, negatively loaded critisism will be issued with a warnings and potential bans.
813

914
---
1015

11-
### Pull Request
16+
## Issues ❗
17+
18+
### Submitting an Issue✅✅
19+
20+
We have three broad categories, to which _you should pick the correct template_. Selecting the correct templates help triage issues, allowing us to resolve the issue faster.
21+
22+
We have **enhancements & features**, **bug reports** and **questions**.
23+
24+
> _todo: expand on these_
25+
26+
#### Enhancements & Features➕➕➕➕ ✅➕➕➕➕➕➕
27+
28+
These are additions to functionality that do are not documented.
29+
30+
#### Bugs
31+
32+
These are related to existing functionality that are documented, but not working correctly.
33+
34+
Functionality bugs without a codesandbox or a jsfiddle will be marked as low priority unless a description is made.
35+
36+
#### Questions
37+
38+
When you have a question about how the code works, or you've become stuck on how to do something.
39+
40+
---
41+
42+
## 🚃🚃🚃Pull Requests 🚃🚃📥🌊🌊
43+
44+
All pull requests should close an issue, unless it:
45+
46+
- Fixes a typo in the documentation
47+
- Adds some documentation
48+
49+
### Workflow
50+
51+
We're aware that easy use nature of the library brings in many new programmers seeking to contribute. Please read the section below for how to do it properly.
52+
53+
#### Git and GitHub CLI
54+
55+
Please read the [GitHub Workflow Guide](https://gist.github.com/Chaser324/ce0505fbed06b947d962) for how to handle git when making changes. This is a great guide and once you learn it here, you can take it everywhere.
56+
57+
You can use the [GitHub CLI](https://github.com/cli/cli) to skip a few steps, as it would create the fork, clone it locally and add both origin and upstream branches.
58+
59+
> todo: add some more detailed instructions for the beginners.
60+
61+
---
62+
63+
## Run locally
64+
65+
The entry points are in `packages/sortablejs`, but most of the code is in `packages/sortable`. We've made this separation in preparation for the future.
66+
67+
### Bootstrap
68+
69+
After creating your fork and/or cloning this repository, please bootstrap (initialize) the repository so code can be run and built.
70+
71+
```sh
72+
# install dependencies with yarn
73+
yarn install
1274

13-
1. Only request to merge with the [master](https://github.com/SortableJS/Sortable/tree/master/)-branch.
14-
2. Only modify source files, **do not commit the resulting build**. Build files are Sortable.js, Sortable.min.js and modular/*.js.
75+
# Use the locally downloaded version of lerna
76+
# to install sub package dependencies
77+
yarn lerna bootstrap
78+
```
1579

16-
### Setup
80+
### Build
1781

18-
1. Fork the repo on [github](https://github.com)
19-
2. Clone locally
20-
3. Run `npm i` in the local repo
82+
Run `yarn build` to build all the files. You should end up with a total of 10 files between the two folders `packages/sortablejs/(dist|modular)`
2183

22-
### Building
84+
_**Note:** Please don't use the following files, as they're deprecated and kept only for backwards compatability:_
2385

24-
- For development, build the `./Sortable.js` file using the command `npm run build:umd:watch`
25-
- To build everything and minify it, run `npm run build`
26-
- Do not commit the resulting builds in any pull request – they will be generated at release
86+
- Sortable.js
87+
- Sortable.min.js
88+
- modular/\*.js.

0 commit comments

Comments
 (0)