-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
1 parent
a798fcf
commit 1dff5e1
Showing
7 changed files
with
146 additions
and
178 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,48 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Create a report to help us improve | ||
| title: "[bug] " | ||
| about: Document a bug with a working example | ||
| title: "" | ||
| labels: "" | ||
| assignees: "" | ||
| --- | ||
|
|
||
| <!-- | ||
| _**[PLEASE READ THE CONTRIBUTION GUIDELINES HERE!](https://github.com/SortableJS/Sortable/tree/master/CONTRIBUTING.md)**_ | ||
|
|
||
| PLEASE READ BEFORE POSTING YOUR ISSUE! | ||
| _Failure to comply may have your issue automatically closed._ | ||
|
|
||
| If your issue is related to a framework or @types/sortablejs, | ||
| please post an issue on it's relevant repository instead: | ||
| ## Reproduction | ||
|
|
||
| - Angular | ||
| - 2.0+: https://github.com/SortableJS/angular-sortablejs/issues | ||
| - legacy: https://github.com/SortableJS/angular-legacy-sortablejs/issues | ||
| - React | ||
| - ES2015+: https://github.com/SortableJS/react-sortablejs/issues | ||
| - mixin: https://github.com/SortableJS/react-mixin-sortablejs/issues | ||
| - Polymer: https://github.com/SortableJS/polymer-sortablejs/issues | ||
| - Knockout: https://github.com/SortableJS/knockout-sortablejs/issues | ||
| - Meteor: https://github.com/SortableJS/meteor-sortablejs/issues | ||
| <!-- Please select a codesandbox to start crafting --> | ||
|
|
||
| <!-- Javascript - https://codesandbox.io/s/sortablejs-javascript-jy3tl?file=/src/index.js --> | ||
| <!-- Typescript - https://codesandbox.io/s/sortablejs-typescript-6it9n?file=/src/index.ts --> | ||
|
|
||
| If it is a bug found from using one of these, please link to the related issue. | ||
| ### Scenario | ||
|
|
||
| --> | ||
| \<codesandbox-url-here\> | ||
|
|
||
| **Describe the bug** | ||
| ### Steps to Reproduce | ||
|
|
||
| <!-- A clear and concise description of what the bug is. --> | ||
|
|
||
| **To Reproduce** | ||
| Steps to reproduce the behavior: | ||
| Summary of steps if applicable. | ||
|
|
||
| 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. --> | ||
|
|
||
| **Information** | ||
|
|
||
| <!-- This is required. Issues without this critical information will be closed. --> | ||
| ## Describe the bug | ||
|
|
||
| Versions - Look in your `package.json` for this information: | ||
| sortablejs = ^x.x.x | ||
| @types/sortablejs = ^x.x.x | ||
|
|
||
| **Additional context** | ||
| Add any other context about the problem here. | ||
|
|
||
| **Reproduction** | ||
| codesandbox: <your_url_here> | ||
|
|
||
| <!-- | ||
| <!-- A clear and concise description of what the bug is. --> | ||
|
|
||
| Providing a codesandbox really helps us understand your issue. | ||
| Bugs with codesandboxes attached are likely to be resolved more quickly than others. | ||
| ## Expected behavior | ||
|
|
||
| Once you've created a public codesandbox, please paste a link in here | ||
| <!-- A clear and concise description of what you expected to happen. --> | ||
|
|
||
| Here are some templates to get you started. | ||
| ## Version | ||
|
|
||
| - Javascript: https://codesandbox.io/s/sortablejs-javascript-jy3tl?file=/src/index.js | ||
| - Typescript: https://codesandbox.io/s/sortablejs-typescript-6it9n?file=/src/index.ts | ||
| | package | version | | ||
| | :------------------ | :------------------ | | ||
| | `sortablejs` | `^x.x.x-?` | | ||
| | `@types/sortablejs` | `^x.x.x-?` \|\| N/A | | ||
|
|
||
| --> | ||
| ## Additional Context |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| name: Question/Feedback | ||
| about: Ask the community a question or give us some feedback! | ||
| title: "" | ||
| labels: "" | ||
| assignees: "" | ||
| --- | ||
|
|
||
| Please answer the following: | ||
|
|
||
| - What result are you trying to achieve and why? | ||
| - Where are you getting stuck at? | ||
|
|
||
| ## Reproduction | ||
|
|
||
| ### Scenario | ||
|
|
||
| <!-- Please select a codesandbox to start crafting --> | ||
|
|
||
| <!-- Javascript - https://codesandbox.io/s/sortablejs-javascript-jy3tl?file=/src/index.js --> | ||
| <!-- Typescript - https://codesandbox.io/s/sortablejs-typescript-6it9n?file=/src/index.ts --> | ||
|
|
||
| \<codesandbox-url-here\> | ||
|
|
||
| ### Steps to Reproduce | ||
|
|
||
| Summary of steps if applicable. | ||
|
|
||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. Looks good | ||
|
|
||
| ## Version | ||
|
|
||
| | package | version | | ||
| | :------------------ | :------------------ | | ||
| | `sortablejs` | `^x.x.x-?` | | ||
| | `@types/sortablejs` | `^x.x.x-?` \|\| N/A | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,88 @@ | ||
| # Contribution Guidelines | ||
|
|
||
| ### Issue | ||
| Thank you for considering to contribute. Please follow the guidelines. | ||
| If the guidelines are not followed, your issues or requests may be closed or left on hold until the requirements are fulfilled. | ||
|
|
||
| 1. Try [master](https://github.com/SortableJS/Sortable/tree/master/)-branch, perhaps the problem has been solved; | ||
| 2. [Use the search](https://github.com/SortableJS/Sortable/search?type=Issues&q=problem), maybe already have an answer; | ||
| 3. If not found, create example on [jsbin.com (draft)](https://jsbin.com/kamiwez/edit?html,js,output) and describe the problem. | ||
| --- | ||
|
|
||
| ## Manners and Etiquette 🎩 | ||
|
|
||
| Please be thoughtful and considerate of others when posting any content within the sortable community. We do this for free, just like you. | ||
|
|
||
| Hate speech and non constructive, negatively loaded critisism will be issued with a warnings and potential bans. | ||
|
|
||
| --- | ||
|
|
||
| ### Pull Request | ||
| ## Issues ❗ | ||
|
|
||
| ### Submitting an Issue✅✅ | ||
|
|
||
| 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. | ||
|
|
||
| We have **enhancements & features**, **bug reports** and **questions**. | ||
|
|
||
| > _todo: expand on these_ | ||
| #### Enhancements & Features➕➕➕➕ ✅➕➕➕➕➕➕ | ||
|
|
||
| These are additions to functionality that do are not documented. | ||
|
|
||
| #### Bugs | ||
|
|
||
| These are related to existing functionality that are documented, but not working correctly. | ||
|
|
||
| Functionality bugs without a codesandbox or a jsfiddle will be marked as low priority unless a description is made. | ||
|
|
||
| #### Questions | ||
|
|
||
| When you have a question about how the code works, or you've become stuck on how to do something. | ||
|
|
||
| --- | ||
|
|
||
| ## 🚃🚃🚃Pull Requests 🚃🚃📥🌊🌊 | ||
|
|
||
| All pull requests should close an issue, unless it: | ||
|
|
||
| - Fixes a typo in the documentation | ||
| - Adds some documentation | ||
|
|
||
| ### Workflow | ||
|
|
||
| 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. | ||
|
|
||
| #### Git and GitHub CLI | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| > todo: add some more detailed instructions for the beginners. | ||
| --- | ||
|
|
||
| ## Run locally | ||
|
|
||
| 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. | ||
|
|
||
| ### Bootstrap | ||
|
|
||
| After creating your fork and/or cloning this repository, please bootstrap (initialize) the repository so code can be run and built. | ||
|
|
||
| ```sh | ||
| # install dependencies with yarn | ||
| yarn install | ||
|
|
||
| 1. Only request to merge with the [master](https://github.com/SortableJS/Sortable/tree/master/)-branch. | ||
| 2. Only modify source files, **do not commit the resulting build**. Build files are Sortable.js, Sortable.min.js and modular/*.js. | ||
| # Use the locally downloaded version of lerna | ||
| # to install sub package dependencies | ||
| yarn lerna bootstrap | ||
| ``` | ||
|
|
||
| ### Setup | ||
| ### Build | ||
|
|
||
| 1. Fork the repo on [github](https://github.com) | ||
| 2. Clone locally | ||
| 3. Run `npm i` in the local repo | ||
| 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)` | ||
|
|
||
| ### Building | ||
| _**Note:** Please don't use the following files, as they're deprecated and kept only for backwards compatability:_ | ||
|
|
||
| - For development, build the `./Sortable.js` file using the command `npm run build:umd:watch` | ||
| - To build everything and minify it, run `npm run build` | ||
| - Do not commit the resulting builds in any pull request – they will be generated at release | ||
| - Sortable.js | ||
| - Sortable.min.js | ||
| - modular/\*.js. |