Skip to content

Commit 7c2ca99

Browse files
committed
📝 CONTRIBUTING guide
1 parent bf5538e commit 7c2ca99

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

CONTRIBUTING

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing to Angular-File-Upload
2+
3+
:+1::tada: Welcome in angular-file-upload community :tada::+1:
4+
5+
The following is a set of guidelines for contributing to Angular-File-Upload.
6+
These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
7+
8+
#### Table Of Contents
9+
10+
* [Reporting Bugs](#reporting-bugs)
11+
* [Suggesting Enhancements](#suggesting-enhancements)
12+
* [Pull Requests](#pull-requests)
13+
14+
## How Can I Contribute?
15+
16+
### Reporting Bugs
17+
18+
This section guides you through submitting a bug report for Angular-File-Upload. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.
19+
20+
Fill out [the required template](ISSUE_TEMPLATE.md), the information it asks for helps us resolve issues faster.
21+
* Before Submitting A Bug Report : **Perform a [quick search](https://github.com/nervgh/angular-file-upload/issues)** to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one.
22+
* When you are creating a bug report, please include as many details as possible, explain the problem and include additional details to help maintainers reproduce the problem:
23+
24+
* **Use a clear and descriptive title** for the issue to identify the problem.
25+
* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you are using Angulare-File-Upload. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you upload a file, explain if you did it by clicking on a button or if you have started the upload programmatically?
26+
* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
27+
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
28+
* **Explain which behavior you expected to see instead and why.**
29+
* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps, **record the GIF with the [Keybinding Resolver](https://github.com/atom/keybinding-resolver) shown**. You can use [this tool](http://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
30+
* **If you're reporting that Angular-File-Upload crashed**, include a crash report with a stack trace from the browser stack. On macOS, the crash report will be available and put it in a [gist](https://gist.github.com/) and provide link to that gist.
31+
32+
Provide more context by answering these questions:
33+
34+
* **Did the problem start happening recently** (e.g. after updating to a new version of Angular-File-Upload) or was this always a problem?
35+
* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
36+
* **Does the problem happen for all files or only some?** Does the problem happen only when working with local or remote files (e.g. on network drives), with files of a specific type (e.g. only JavaScript or Python files), with large files or files with very long lines, or with files in a specific encoding? Is there anything else special about the files you are using?
37+
38+
Include details about your configuration and environment:
39+
40+
* **Which browser are you using?** ?
41+
* **What's the name and version of the OS you're using**?
42+
43+
### Suggesting Enhancements
44+
45+
This section guides you through submitting an enhancement suggestion for Angular-File-Upload, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
46+
* Before Submitting An Enhancement : **Perform a [quick search](https://github.com/nervgh/angular-file-upload/issues)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
47+
48+
Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Provide the following information:
49+
50+
* **Use a clear and descriptive title** for the issue to identify the suggestion.
51+
* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
52+
* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
53+
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
54+
* **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of Atom which the suggestion is related to. You can use [this tool](http://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
55+
* **Explain why this enhancement would be useful** to most Angular-File-Upload users.
56+
* **List some other uploader libs or usages where this enhancement exists.**
57+
58+
### Pull Requests
59+
60+
* Follow [standardJS](https://github.com/feross/standard) styleguides.
61+
* Include thoughtfully-worded, [protractor](http://www.protractortest.org/#/) tests
62+
* Document new code based using [jsdoc](http://usejsdoc.org/)

0 commit comments

Comments
 (0)