Skip to content

Commit 613a1a0

Browse files
docs: add contributing section to README for contribution guidelines (#3)
1 parent dced46e commit 613a1a0

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-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 to Exercise Toolkit
2+
3+
Thank you for your interest in contributing to the Exercise Toolkit! This document provides guidelines to help you contribute effectively.
4+
5+
## Conventional Pull Request Titles
6+
7+
This project enforces [conventionalcommit](https://www.conventionalcommits.org/en/v1.0.0/) style formatting for pull request titles to automate versioning and release processes.
8+
9+
We do not require that every commit follows the conventionalcommits style, just the pull request title. Pull requests are squashed with the PR title as the commit message.
10+
11+
Each PR title must follow this format:
12+
13+
```
14+
<type>(optional <scope>): <description>
15+
```
16+
17+
18+
19+
### Examples
20+
21+
```
22+
feat: add workflow to start exercise
23+
fix(templates): correct typo in step feedback template
24+
```
25+
26+
### Breaking Changes
27+
28+
For breaking changes, append `!` after type/scope
29+
30+
```
31+
feat!: change workflow inputs
32+
feat(templates)!: change required variables for congratulations template
33+
```
34+

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,7 @@ This repository serves as a comprehensive toolkit for creating and managing GitH
1212

1313
- **[.github/workflows](/.github/workflows)**: GitHub Actions workflows for automating common parts of Skills Exercises
1414
- **[markdown-templates](/markdown-templates)**: Ready-to-use Markdown templates for creating consistent exercise documentation, instructions, and README files
15+
16+
## Contributing
17+
18+
For contribution guidelines, see our [CONTRIBUTING.md](/CONTRIBUTING.md) file.

0 commit comments

Comments
 (0)