UNPKG

5.11 kB Markdown View Raw
1# Contributing to TableFilter
2:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
3
4## Reporting bugs
5Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
6Create an issue and provide the following information.
7
8Explain the problem and include additional details to help maintainers reproduce
9the problem:
10
11* **Use a clear, concise and descriptive title** for the issue to identify the
12problem.
13* **Describe the exact steps which reproduce the problem** in as many details
14as possible.
15* **Provide specific examples to demonstrate the steps**. Include links to
16files or GitHub projects, or copy/pasteable snippets, which you use in those
17examples. If you're providing snippets in the issue, use
18[Markdown code blocks](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown).
19Do not paste large snippets completely unrelated to the issue.
20* **Describe the behavior you observed after following the steps** and point
21out what exactly is the problem with that behavior.
22* **Explain which behavior you expected to see instead and why.**
23* Do not hesitate to **include screenshots and animated GIFs** which show you
24following the described steps and clearly demonstrate the problem.
25You can use [this tool](http://www.cockos.com/licecap/) to record GIFs on macOS
26and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or
27[this tool](https://github.com/GNOME/byzanz) on Linux.
28
29### Template for submitting bug reports
30
31 [Short description of problem here]
32
33 **Reproduction steps:**
34
35 1. [First Step]
36 2. [Second Step]
37 3. [Other Steps...]
38
39 **Expected behavior:**
40
41 [Describe expected behavior here]
42
43 **Observed behavior:**
44
45 [Describe observed behavior here]
46
47 **Screenshots and GIFs**
48
49 ![Screenshots and GIFs which follow reproduction steps to demonstrate the
50 problem](url)
51
52 **TableFilter version:** [Enter TableFilter version here]
53 **Browser and version:** [Enter Browser name and version here]
54 **OS and version:** [Enter OS name and version here]
55
56 **Additional information:**
57
58 * Problem started happening recently, didn't happen in an older version of
59 TableFilter: [Yes/No]
60 * Problem can be reliably reproduced, doesn't happen randomly: [Yes/No]
61
62## Suggesting enhancements and features
63Enhancement and feature suggestions are tracked as
64[GitHub issues](https://guides.github.com/features/issues/).
65Create an issue and provide the following information:
66
67* **Use a clear and descriptive title** for the issue to identify the
68suggestion.
69* **Provide a step-by-step description of the suggested enhancement/feature**
70in as many details as possible.
71* When applicable **describe the current behavior** and
72**explain which behavior you expected to see instead** and why.
73* **Include screenshots and animated GIFs** which help you demonstrate the
74steps or point out the part of TableFilter which the suggestion is related to.
75You can use [this tool](http://www.cockos.com/licecap/) to record GIFs on macOS
76and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or
77[this tool](https://github.com/GNOME/byzanz) on Linux.
78* **Explain why this enhancement would be useful** to most TableFilter users.
79
80### Template for submitting enhancement and feature suggestions
81
82 [Short description of suggestion]
83
84 **Steps which explain the enhancement/feature**
85
86 1. [First Step]
87 2. [Second Step]
88 3. [Other Steps...]
89
90 **Current and suggested behavior**
91
92 [Describe current and suggested behavior here]
93
94 **Why would the enhancement be useful to most users**
95
96 [Explain why the enhancement would be useful to most users]
97
98 **Screenshots and GIFs**
99
100 ![Screenshots and GIFs which demonstrate the steps or part of TableFilter
101 the enhancement suggestion is related to](url)
102
103 **TableFilter Version:** [Enter TableFilter version here]
104 **Browser and version:** [Enter Browser name and version here]
105 **OS and version:** [Enter OS name and version here]
106
107## Code contribution
108TableFilter welcomes contributions from anyone and everyone. If you want to get
109your hands dirty:
110
111### Pull requests
112In general, we follow the "fork-and-pull" Git workflow.
113
114 1. **Fork** the repo on GitHub
115 2. **Clone** the project to your own machine
116 3. **Commit** changes to your own branch
117 - 3.1. **Add** unit tests covering your change in the `test` folder
118 - 3.2. **Run** the tests with the `npm run eslint test` command
119 - 3.3. **Ensure** build is working with `npm run dist` command
120 4. **Push** your work back up to your fork
121 5. Submit a **Pull request** so that we can review your changes
122
123NOTE: Be sure to merge the latest from "upstream" before making a pull request!
124
125## Donations
126Support this project by donating [here](http://www.tablefilter.com/donate.html).
127Thanks to all those who supported this project in the past and those who will
128in the future!