Skip to content

Commit 2008a5c

Browse files
committed
docs: add CONTRIBUTING
1 parent d8a5739 commit 2008a5c

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing to SpringQL-client-c
2+
3+
Welcome, and thank you for your interest in contributing to SpringQL-client-c!
4+
5+
There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
6+
7+
## Asking Questions
8+
9+
Have a question? Rather than opening an issue, use [Discussions](https://github.com/SpringQL/SpringQL-client-c/discussions) and open a post.
10+
11+
## Providing Feedback
12+
13+
Use [Discussions](https://github.com/SpringQL/SpringQL-client-c/discussions) as well. Your comments and feedback are welcome.
14+
15+
## Reporting Issues
16+
17+
Have you identified a reproducible problem in SpringQL? Have a feature request? We want to hear about it! Here's how you can report your issue as effectively as possible.
18+
19+
### Look For an Existing Issue
20+
21+
Before you create a new issue, please do a search in [open issues](https://github.com/SpringQL/SpringQL-client-c/issues) to see if the issue or feature request has already been filed.
22+
23+
### Writing Good Bug Reports and Feature Requests
24+
25+
File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.
26+
27+
Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar but have different causes.
28+
29+
The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.
30+
31+
Please use the issue template from GitHub web.
32+
33+
## Creating Pull Requests
34+
35+
Any fixes or features' addition/removal should be submitted via pull-requests.
36+
37+
Ideally, each pull-request is linked to a single issue.
38+
39+
Before we can accept a pull request from you, you'll need to sign a Contributor License Agreement (CLA). It is an automated process and you only need to do it once.
40+
41+
# Thank You!
42+
43+
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.

0 commit comments

Comments
 (0)