Skip to content

Commit 0435452

Browse files
cmccarthy1sshanks-kx
authored andcommitted
Addition of CONTRIBUTING.md and issue templates (KxSystems#22)
* Minor update to makefile * readdition of makefile * Addition of CONTRIB file and issue templates
1 parent c913ae5 commit 0435452

File tree

3 files changed

+95
-0
lines changed

3 files changed

+95
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Please provide the steps which need to be taken to reproduce the issue. This should include appropriate code snippets where relevant. In the case of build issues please provide a link to the instructions followed and if diverging from the recommended steps an explanation as to why.
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Screenshots**
20+
If applicable, add screenshots to help explain your problem.
21+
22+
**Desktop (please complete the following information):**
23+
- OS: [e.g. Ubuntu 18.04 LTS (If using Ubuntu please provide flavour .i.e Redhat)]
24+
- KDB+ banner information [e.g. KDB+ 3.5 2017.09.06 Copyright (C) 1993-2017 Kx Systems l64/ 8()core 64303MB]
25+
- Repository version [e.g. 0.1.0]
26+
27+
**Additional context**
28+
Add any other context about the problem here.
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. For example "It would be useful if the interface could handle type ... automatically this is causing me an issue in ..."
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions to the problem. For example "Handling natively would be useful but I have been using an alternative library ... to handle until now".
18+
19+
**Additional resource**
20+
Please provide any relevant links which you believe provide more context for this feature request or which point to relevant documentation which will make implementation more seamless.

CONTRIBUTING.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# How to contribute
2+
3+
Thanks for choosing to contribute to this project.
4+
5+
If you haven't already, please view the [README](README.md) for an introduction to the aims and intended use of this project.
6+
7+
## Contributing as a user (non-development)
8+
9+
As a non-developer, you can still contribute in many ways. We are especially interested in hearing from people using the project in production/working environments.
10+
11+
If you spot any problems, please raise an issue within the project and provide as much information as possible. This should enable us to recreate the issue and check that any fix is appropriate.
12+
13+
Feature requests can also be raised in the project as a new issue. Please detail what you may wish to be added, why you would benefit from it and any other information that may be relevant.
14+
15+
You may also wish to 'star' the project (click the star link on the project main page) to show your appreciation.
16+
17+
## Contributing as a developer
18+
19+
### Getting Started
20+
21+
If you are looking to lend your development skills to the project, you can check the projects issue list to see what people may be looking for. Developers who already have an idea of what they might like to change should consider creating an issue to indicate to others of the work they are undertaking and commence any discussion on the possible solutions.
22+
23+
### Making Changes
24+
25+
Please fork the projects master branch to your own account. Using your fork, you are free to create changes or create branches in isolation.
26+
27+
The following provides a good general guide ['Beginners Guide To Contributing'](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/)
28+
29+
Please keep your fork up-to date to reduce the risk of conflicts occurring when your come to submit any changes.
30+
31+
It can also be worth considering if your changes may also require changes to documentation or dependent systems.
32+
33+
### Submitting Changes
34+
35+
When committing changes, please provide a descriptive commit comment of why the change was made (e.g. 'fixed bug' is not a suitable comment as it doesn't describe which bug).
36+
37+
You can link to a relevant issue in a commit comment by referencing the issue number prefixed with a '#'.
38+
39+
After pushing to your fork, submit a pull request against the main projects master branch.
40+
41+
In order to have your pull request approved in a timely manner, please provide comments on the pull request that details what was changed & for which reasons. The complexity or size of the change indicate the size of the descriptions required, in order for the reviewer to get up to speed as quick as possible.
42+
43+
### Additional Resources
44+
45+
[Kx Kafka Documentation](https://code.kx.com/q/interfaces/kafka/)
46+
[librdkafka C Documentation](https://docs.confluent.io/2.0.0/clients/librdkafka/rdkafka_8h.html#ab66a2c014db2e652aa12466b137a6200)
47+

0 commit comments

Comments
 (0)