Skip to content

Commit 4163d56

Browse files
authored
Add CONTRIBUTING.md (#488)
* Add templates for GitHub Issues Add templates to be used when creating GitHub issues so that users know what information is expected from them. Signed-off-by: Tomáš Nevrlka <[email protected]> * Add CONTRIBUTING.md Contributors should know what is expected in their contributions. Add a file that describes it. Signed-off-by: Tomáš Nevrlka <[email protected]> --------- Signed-off-by: Tomáš Nevrlka <[email protected]>
1 parent a84d253 commit 4163d56

File tree

3 files changed

+111
-0
lines changed

3 files changed

+111
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Bug report
3+
title: ''
4+
labels: bug
5+
assignees: ''
6+
---
7+
8+
## Problem Description
9+
Brief description of the issue
10+
11+
## Steps to Reproduce
12+
1. Step one
13+
2. Step two
14+
3. Step three
15+
16+
## Current Behavior
17+
What actually happens
18+
19+
## Expected Behavior
20+
What should happen
21+
22+
## Other information
23+
Logs, error messages, etc.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
title: ''
4+
labels: enhancement
5+
assignees: ''
6+
---
7+
8+
## Use Case
9+
Describe the problem or need this feature would address
10+
11+
## Proposed Solution
12+
Your suggested implementation approach
13+
14+
## Alternatives Considered
15+
Other potential solutions
16+
17+
## Additional Context
18+
Any other relevant information

CONTRIBUTING.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Contributing to build-service
2+
3+
## Table of Contents
4+
5+
* [Project Overview](#project-overview)
6+
* [How to Report Issues](#how-to-report-issues)
7+
* [How to Submit Pull Requests](#how-to-submit-pull-requests)
8+
* [Development Workflow](#development-workflow)
9+
* [Pull Request Guidelines](#pull-request-guidelines)
10+
* [Security Best Practices](#security-best-practices)
11+
12+
* [Review Process](#review-process)
13+
14+
## Build service
15+
16+
The build-service repository is used in [Konflux](https://konflux-ci.dev).
17+
Therefore, everybody should follow its [Code of Conduct](https://github.com/konflux-ci/community/blob/main/CODE_OF_CONDUCT.md).
18+
19+
## How to Report Issues
20+
21+
- We encourage early communication for all types of contributions.
22+
- Before filing an issue, make sure to check if it is not reported already.
23+
- If the contribution is non-trivial (straightforward bugfixes, typos, etc.), please open an issue to discuss your plans and get guidance from maintainers.
24+
- Please fill out included issue templates with all applicable information.
25+
26+
## How to Submit Pull Requests
27+
28+
### Development Workflow
29+
30+
1. **Fork and Clone**: Fork this repository and clone your fork
31+
2. **Create Feature Branch**: Create a new topic branch based on `main`
32+
3. **Make Changes**: Implement your changes
33+
4. **Commit Changes**: See [commit guidelines](#pull-request-guidelines)
34+
35+
### Pull Request Guidelines
36+
37+
**Commit Requirements:**
38+
- Write clear, descriptive commit titles. Should fit under 50 characters
39+
- Write meaningful commit descriptions with each line having less than 72 characters
40+
- Split your contribution into several commits if applicable, each should represent a logical chunk
41+
- Add line `Assisted-by: <name-of-ai-tool>` if you used an AI tool for your contribution
42+
- Sign-off your commits in order to certify that you adhere to [Developer Certificate of Origin](https://developercertificate.org)
43+
44+
**Pull Request Content:**
45+
- **Title**: Clear, descriptive title. Should fit under 72 characters.
46+
- **Description**: Explain the overall changes and their purpose, this should be a cover letter for your commits.
47+
- **Testing**: Describe how the changes were tested
48+
- **Links**: Reference related issues or upstream stories.
49+
50+
**Remember:**
51+
- Konflux is a community project and proper descriptions cannot be replaced by referencing a publicly inaccessible link to Jira or any other private resource.
52+
- Reviewers, other contributors and future generations might not have the same context as you have at the moment of PR submission.
53+
54+
### Security basics
55+
56+
- Never commit secrets or keys to the repository
57+
- Never expose or log sensitive information
58+
59+
## Review Process
60+
61+
**Requirements for Approval:**
62+
- All CI checks pass
63+
- Code review approval from maintainers
64+
65+
**Review Criteria:**
66+
- The contribution follows established patterns and conventions
67+
- Changes are tested and documented
68+
- Security best practices are followed
69+
70+
For any questions or help with contributing, please open an issue or reach out to the maintainers.

0 commit comments

Comments
 (0)