Skip to content

Commit b57c704

Browse files
authored
Add contributing information (CircleCI-Public#88)
1 parent 32b07bd commit b57c704

File tree

6 files changed

+132
-5
lines changed

6 files changed

+132
-5
lines changed

.github/CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# CircleCI Docker Convenience Image Contributions
2+
3+
We welcome all contributions to our CircleCI Docker Convenience Image repositories from the community!
4+
5+
This file outlines best practices for contributions and what you can expect from the images team at CircleCI.
6+
7+
## Image Support Policy
8+
9+
For our official CircleCI Docker Convenience Image support policy, please see [CircleCI docs](https://circleci.com/docs/convenience-images-support-policy).
10+
11+
This policy outlines the release, update, and deprecation policy for CircleCI Docker Convenience Images.
12+
13+
## Issues
14+
15+
Please open issues for feature requests and bug reports. Depending on the type of issue, please fill out the issue template with as much information as possible.
16+
17+
The more information you can provide about your issue, the better we can help address the issue promptly!
18+
19+
For feature requests, in order for us to add a tool within the image, it has to be something that is maintained and useful to a majority of CircleCI users. Every tool added makes the image larger and slower for all users, so any new additions need to be carefully thought out.
20+
21+
While we make every effort to respond to issues quickly, however please note that we do not provide an official SLA for this.
22+
23+
## Contributions and Pull Requests
24+
25+
When making changes to CircleCI Docker Convenience Images, please only make these changes in the `Dockerfile.template` file in the root of the repository.
26+
27+
Our build and releases scripts generate new Dockerfiles based on the `Dockerfile.template` file and overwrite the Dockerfiles in the version directories. Therefore, only changes made to the `Dockerfile.template` file will be valid for a pull request as changes to other files will be lost.
28+
29+
Additionally, please do not make changes to any of the build or push bash script files as these are also automatically generated.
30+
31+
Ensure extra layers are not added to the Dockerfile where it is not necessary. We aim to keep layer count low to ensure good caching in the CircleCI execution environment.
32+
33+
Please fill out the pull request template when opening a new pull request. This helps us to look into new pull requests in a timely manner.
34+
35+
While we make every effort to respond to pull requests quickly, however please note that we do not provide an official SLA for this.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug Report
3+
about: Create a bug report for this image
4+
title: 'Bug Report: <BUG>'
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
*Note: We also welcome PRs to fix bugs! This helps us take action faster where a bug has been identified!*
11+
12+
For our official CircleCI Docker Convenience Image support policy, please see [CircleCI docs](https://circleci.com/docs/convenience-images-support-policy).
13+
14+
This policy outlines the release, update, and deprecation policy for CircleCI Docker Convenience Images.
15+
16+
---
17+
18+
**Describe the bug**
19+
A clear and concise description of what the bug is.
20+
21+
**To Reproduce**
22+
Please provide steps to reproduce the behavior, such as a sample job or config file.
23+
24+
**Expected behavior**
25+
A clear and concise description of what you expected to happen.
26+
27+
**Workarounds**
28+
Are there any current workarounds for this bug that can be used currently?
29+
30+
**Screenshots and Build Links**
31+
If possible, add screenshots and links to jobs to help explain your problem.
32+
33+
**Additional context**
34+
Add any other context about the problem here.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Feature Request
3+
about: Create a feature / enhancement request for this image
4+
title: 'Feature Request: <FEATURE>'
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
For our official CircleCI Docker Convenience Image support policy, please see [CircleCI docs](https://circleci.com/docs/convenience-images-support-policy).
11+
12+
This policy outlines the release, update, and deprecation policy for CircleCI Docker Convenience Images.
13+
14+
---
15+
16+
**Describe the Feature Request**
17+
Please describe the feature request.
18+
19+
**Is your feature request related to a particular problem?**
20+
A clear and concise description of what the problem is.
21+
22+
**How will this feature request benefit CircleCI jobs using this image?**
23+
For example, will it help speed up jobs significantly by not having to install a commonly used package every run?
24+
25+
In order for us to add a tool within the image, it has to be something that is maintained and useful to a majority of CircleCI users. Every tool added makes the image larger and slower for all users, so any new additions need to be carefully thought out.
26+
27+
**Describe the solution you would like to see**
28+
A clear and concise description of what you would like to see for this feature request. For example "I like like to see xyz package installed by default in the image".
29+
30+
**Describe alternatives you have considered**
31+
A clear and concise description of any alternative solutions you have considered, such as different packages or workarounds.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: CircleCI Discuss Community Forum
4+
url: https://discuss.circleci.com
5+
about: Community forum for CircleCI users

.github/pull_request_template.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
For our official CircleCI Docker Convenience Image support policy, please see [CircleCI docs](https://circleci.com/docs/convenience-images-support-policy).
2+
3+
This policy outlines the release, update, and deprecation policy for CircleCI Docker Convenience Images.
4+
5+
---
6+
7+
# Description
8+
A brief description of the changes in this PR.
9+
10+
# Reasons
11+
Please provide reasoning for these changes and how this PR achieves them.
12+
13+
If applicable, include a link to the related GitHub issue that this PR will close.
14+
15+
# Checklist
16+
17+
Please check through the following before opening your PR. Thank you!
18+
19+
- [ ] I have made changes to the `Dockerfile.template` file only
20+
- [ ] I have not made any manual changes to automatically generated files
21+
- [ ] My PR follows best practices as described in the [contributing guidelines](CONTRIBUTING)
22+
- [ ] (Optional, but recommended) My commits are [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414

1515
`cimg/postgres` is a Docker image created by CircleCI with continuous integration builds in mind.
1616

17+
## Support Policy
18+
19+
The CircleCI Docker Convenience Image support policy can be found on the [CircleCI docs](https://circleci.com/docs/convenience-images-support-policy) site. This policy outlines the release, update, and deprecation policy for CircleCI Docker Convenience Images.
1720

1821
## Table of Contents
1922

@@ -216,12 +219,9 @@ Don't forget that to see any of these changes locally, the `gen-dockerfiles.sh`
216219

217220
## Contributing
218221

219-
We encourage [issues](https://github.com/CircleCI-Public/cimg-postgres/issues) and [pull requests](https://github.com/CircleCI-Public/cimg-postgres/pulls) against this repository. In order to value your time, here are some things to consider:
220-
221-
1. We won't include just anything in this image. In order for us to add a tool within the PostgreSQL image, it has to be something that is maintained and useful to a large number of PostgreSQL users. Every tool added makes the image larger and slower for all users so being thorough on what goes in the image will benefit everyone.
222-
1. PRs are welcome. If you have a PR that will potentially take a large amount of time to make, it will be better to open an issue to discuss it first to make sure it's something worth investing the time in.
223-
1. Issues should be used to report bugs or request additional/removal of tools in this image. For help with images, please visit [CircleCI Discuss](https://discuss.circleci.com/c/ecosystem/circleci-images).
222+
We encourage [issues](https://github.com/CircleCI-Public/cimg-postgres/issues) and [pull requests](https://github.com/CircleCI-Public/cimg-postgres/pulls) against this repository.
224223

224+
Please check out our [contributing guide](.github/CONTRIBUTING.md) which outlines best practices for contributions and what you can expect from the images team at CircleCI.
225225

226226
## Additional Resources
227227

0 commit comments

Comments
 (0)