Skip to content

Commit 7e40b1e

Browse files
authored
Merge pull request #238 from marklogic/MLE-4194/Add-Contributing-file
MLE-4194 : Add contributing file
2 parents e63f599 + abe6c85 commit 7e40b1e

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to MarkLogic-kubernetes
2+
3+
Thank you for your interest in contributing to this project! We welcome contributions from the community to make this project better.
4+
5+
- [Found an Issue](#found-an-issue)
6+
- [Want a Feature](#want-a-feature)
7+
- [Getting Started](#getting-started)
8+
- [PR management](#pr-management)
9+
10+
## Found an Issue?
11+
12+
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue
13+
to our [GitHub Issue Tracker][Issue Tracker]. If you'd like to submit a feature enhancement, please first create an
14+
issue with your proposed idea so that we can start a discussion about the problem you want to solve and what the best
15+
solution would be.
16+
17+
## Want a Feature?
18+
19+
You can request a new feature by submitting an issue to our [GitHub Issue Tracker][Issue Tracker]. If you
20+
would like to implement a new feature then first create a new issue and discuss it with one of our
21+
project maintainers.
22+
23+
## Getting Started
24+
25+
To get started with contributing, please follow these steps:
26+
27+
1. Fork the repository and clone it to your local machine.
28+
2. Install the necessary dependencies.
29+
3. Create a new branch for your changes.
30+
4. Make your desired changes to the codebase.
31+
5. Test your changes thoroughly.
32+
6. Tests can be done using the test framework. See [test folder](./test/) and [Makefile](makefile)
33+
34+
## PR management
35+
36+
Created PR will not be merge as is.
37+
The MarkLogic kubernetes team will use the PRs for "inspiration" but not merge the changes in directly. They may rewrite the code as they like, incorporating the submitted changes into their own code.
38+
39+
**Important:** Please open an issue in the [Issue Tracker][] and get your proposed changes pre-approved by at least one of the project maintainers before you start coding. Nothing is more frustrating than seeing your hard work go to waste because your vision does not align with that of the project maintainers.
40+
41+
[Issue Tracker]: https://github.com/marklogic/marklogic-kubernetes/issues

0 commit comments

Comments
 (0)