Skip to content

Commit 0087ca9

Browse files
committed
update readme / contributing
1 parent 46139de commit 0087ca9

File tree

2 files changed

+39
-5
lines changed

2 files changed

+39
-5
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
# What can I contribute?
3+
4+
## 🌟 suggestions/requests for new features or changes
5+
6+
Please be sure to give a thorough explanation of what your suggestion is, and why/how you think it is useful. If you have a specific use case, any information about it, and links to it will be very helpful.
7+
8+
At the core, though, this is a component with a purpose. I will be the final judge of if the purpose is valid. Your adoption is your own perogative. You are free to fork and modify to suit your own needs.
9+
10+
## 🛠 pull-requests for bug fixes, or issue resolution
11+
12+
If there are any open issues, or you find a valid bug, please feel free to open a pull-request for review. I won't accept pull-requests for dependency updates, but those can be requested as an issue.
13+
14+
**Please stick to the code formatting and style already in place.**
15+
16+
When making changes/edits to the code you should use the `/test/` folder and check the [README.md](test/README.md) in there to help with testing all the functionality.
17+
18+
## 🧪 help with creating a proper test-suite
19+
20+
I am considering how to add a test-suite as this component has a lot of different options and possible outcomes. I am not currently familiar with how to do this in Svelte, so any help/advice is appreciated.
21+
22+
**The main goal would be to make it super simple to setup and run / expand for anyone contributing, and I wouldn't accept if it seems obtuse.**

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ A reactive, accessible, multi-thumb, range slider for use in a svelte applicatio
1111

1212
---
1313

14+
## features
15+
16+
- ✨ fully customisable
17+
- ✨ fully stylable
18+
- ✨ fully accessible (with aria)
19+
- 👍🏽 multi-thumb
20+
- 🎚 range (min/max)
21+
- 🏷 floating labels
22+
- 📏 ruler notches
23+
- 🏷 labels for notches
24+
- 🧮 step function
25+
- 🖍 formatter
26+
- 🎭 animated
27+
1428
## install
1529

1630
Open your project and use the command line to install the package;
@@ -89,14 +103,12 @@ prop | type | default | description
89103
**[🔗 _For full documentation and examples, see the Github Pages_](https://simeydotme.github.io/svelte-range-slider-pips/)**
90104

91105

92-
## contribue
106+
## contribute
93107

94108
I am very happy to accept;
95-
- 🌟 suggestions/requests for new features or changes with examples of how they would be useful
109+
- 🌟 suggestions/requests for new features or changes
96110
- 🛠 pull-requests for bug fixes, or issue resolution
97111
- 🧪 help with creating a proper test-suite
98112

99-
**When making changes/edits to the code you should use the `/test/` folder** and check the [README.md](test/README.md) in there
100-
to help with testing all the functionality. I don't have real tests set up, and would appreciate anyone's
101-
help who knows how to accomplish that.
113+
[Read the CONTRIBUTING.md](./CONTRIBUTING.md)
102114

0 commit comments

Comments
 (0)