You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+51-1Lines changed: 51 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,56 @@
1
1
# Contributing to TaskTracker
2
2
3
-
Thank you for your interest in contributing to TaskTracker! This document provides guidelines and information for contributors.
3
+
We love your input! We want to make contributing to TaskTracker as easy and transparent as possible, whether it's:
4
+
5
+
- Reporting a bug
6
+
- Discussing the current state of the code
7
+
- Submitting a fix
8
+
- Proposing new features
9
+
- Becoming a maintainer
10
+
11
+
## We Develop with GitHub
12
+
13
+
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
14
+
15
+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html)
16
+
17
+
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
18
+
19
+
1. Fork the repo and create your branch from `main`.
20
+
2. If you've added code that should be tested, add tests.
21
+
3. If you've changed APIs, update the documentation.
22
+
4. Ensure the test suite passes.
23
+
5. Make sure your code lints.
24
+
6. Issue that pull request!
25
+
26
+
## Any contributions you make will be under the MIT Software License
27
+
28
+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
29
+
30
+
## Report bugs using GitHub's [issue tracker](https://github.com/DVC2/task_tracker/issues)
31
+
32
+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/DVC2/task_tracker/issues/new); it's that easy!
33
+
34
+
## Write bug reports with detail, background, and sample code
35
+
36
+
**Great Bug Reports** tend to have:
37
+
38
+
- A quick summary and/or background
39
+
- Steps to reproduce
40
+
- Be specific!
41
+
- Give sample code if you can.
42
+
- What you expected would happen
43
+
- What actually happens
44
+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
45
+
46
+
## Use a Consistent Coding Style
47
+
48
+
* Use 2 spaces for indentation rather than tabs
49
+
* You can try running `npm run lint` for style unification
50
+
51
+
## License
52
+
53
+
By contributing, you agree that your contributions will be licensed under its MIT License.
0 commit comments