Skip to content

Commit 413af6d

Browse files
authored
Merge pull request #130 from Charliekenney23/add-contrib-doc
Add contributing documentation
2 parents ef26af6 + 172d043 commit 413af6d

File tree

3 files changed

+96
-0
lines changed

3 files changed

+96
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing Guidelines
2+
3+
:+1::tada: First off, we appreciate you taking the time to contribute! THANK YOU! :tada::+1:
4+
5+
We put together the handy guide below to help you get support for your work. Read on!
6+
7+
## I Just Want to Ask the Maintainers a Question
8+
9+
The [Linode Community](https://www.linode.com/community/questions/) is a great place to get additional support.
10+
11+
## How Do I Submit A (Good) Bug Report or Feature Request
12+
13+
Please open a [github issue](https://guides.github.com/features/issues/) to report bugs or suggest features.
14+
15+
When filing an issue or feature request, help us avoid duplication and redundant effort -- check existing open or recently closed issues first.
16+
17+
Detailed bug reports and requests easier for us to work with. Please include the following in your issue:
18+
19+
* A reproducible test case or series of steps
20+
* The version of our code being used
21+
* Any modifications you've made, relevant to the bug
22+
* Anything unusual about your environment or deployment
23+
* Screenshots and code samples where illustrative and helpful
24+
25+
## How to Open a Pull Request
26+
27+
We follow the [fork and pull model](https://opensource.guide/how-to-contribute/#opening-a-pull-request) for open source contributions.
28+
29+
Tips for a faster merge:
30+
* address one feature or bug per pull request.
31+
* large formatting changes make it hard for us to focus on your work.
32+
* follow language coding conventions.
33+
* make sure that tests pass.
34+
* make sure your commits are atomic, [addressing one change per commit](https://chris.beams.io/posts/git-commit/).
35+
* add tests!
36+
37+
## Code of Conduct
38+
39+
This project follows the [Linode Community Code of Conduct](https://www.linode.com/community/questions/conduct).
40+
41+
## Vulnerability Reporting
42+
43+
If you discover a potential security issue in this project we ask that you notify Linode Security via our [vulnerability reporting process](https://hackerone.com/linode). Please do **not** create a public github issue.
44+
45+
## Licensing
46+
47+
See the LICENSE file for our project's licensing.

.github/ISSUE_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## General:
2+
3+
* [ ] Have you removed all sensitive information, including but not limited to access keys and passwords?
4+
* [ ] Have you checked to ensure there aren't other open or closed [Pull Requests](../../pulls) for the same bug/feature/question?
5+
6+
----
7+
8+
## Feature Requests:
9+
* [ ] Have you explained your rationale for why this feature is needed?
10+
* [ ] Have you offered a proposed implementation/solution?
11+
12+
----
13+
14+
## Bug Reporting
15+
16+
### Expected Behavior
17+
18+
### Actual Behavior
19+
20+
### Steps to Reproduce the Problem
21+
22+
1.
23+
1.
24+
1.
25+
26+
### Environment Specifications
27+
28+
#### Screenshots, Code Blocks, and Logs
29+
30+
#### Additional Notes
31+
32+
----
33+
34+
The [Linode Community](https://www.linode.com/community/questions/) is a great place to get additional support.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### General:
2+
3+
* [ ] Have you removed all sensitive information, including but not limited to access keys and passwords?
4+
* [ ] Have you checked to ensure there aren't other open or closed [Pull Requests](../../pulls) for the same bug/feature/question?
5+
6+
### Pull Request Guidelines:
7+
8+
1. [ ] Does your submission pass tests?
9+
1. [ ] Have you added tests?
10+
1. [ ] Are you addressing a single feature in this PR?
11+
1. [ ] Are your commits atomic, addressing one change per commit?
12+
1. [ ] Are you following the conventions of the language?
13+
1. [ ] Have you saved your large formatting changes for a different PR, so we can focus on your work?
14+
1. [ ] Have you explained your rationale for why this feature is needed?
15+
1. [ ] Have you linked your PR to an [open issue](https://blog.github.com/2013-05-14-closing-issues-via-pull-requests/)

0 commit comments

Comments
 (0)