Skip to content
This repository was archived by the owner on Jul 18, 2024. It is now read-only.

Commit 76742e2

Browse files
authored
Create CONTRIBUTING.md
1 parent 9cfa61e commit 76742e2

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Contributing In General
2+
Our project welcomes external contributions! If you have an itch, please feel free to scratch it.
3+
4+
To contribute code or documentation, please submit a pull request to the [GitHub repository](https://github.com/IBM/drupal-nginx-php-kubernetes).
5+
6+
A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/IBM/drupal-nginx-php-kubernetes/issues). Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us.
7+
8+
**We appreciate your effort, and want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in the queue for a long time, or cannot be accepted at all!**
9+
10+
### Proposing new features
11+
12+
If you would like to implement a new feature, please [raise an issue](https://github.com/IBM/drupal-nginx-php-kubernetes/issues) before sending a pull request so the feature can be discussed.
13+
This is to avoid you spending your valuable time working on a feature that the project developers are not willing to accept into the code base.
14+
15+
### Fixing bugs
16+
17+
If you would like to fix a bug, please [raise an issue](https://github.com/IBM/drupal-nginx-php-kubernetes/issues) before sending a pull request so it can be discussed.
18+
If the fix is trivial or non controversial then this is not usually necessary.
19+
20+
### Merge approval
21+
22+
The project maintainers use LGTM (Looks Good To Me) in comments on the code review to
23+
indicate acceptance. A change requires a LGTMs from one of the maintainers.
24+
25+
For more details, see the [MAINTAINERS](MAINTAINERS.md) page.
26+
27+
## Setup
28+
Please add any special setup instructions for your project to help the developer become productive quickly.
29+
30+
## Testing
31+
Please provide information that helps the developer test any changes they make before submitting.
32+
33+
## Coding style guidelines
34+
Beautiful code rocks! Please share any specific style guidelines you might have for your project.

0 commit comments

Comments
 (0)