Skip to content

Commit

Permalink
Merge pull request #15 from svsticky/doc/hacktoberfest
Browse files Browse the repository at this point in the history
CONTRIBUTING.md for the hacktoberfest
  • Loading branch information
TobiasDeBruijn authored Sep 30, 2023
2 parents a47d144 + f5a0937 commit d1c35c2
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributing
So you're thinking about contributing to our photo-display webpage, great!
To make sure every contributor is on the same 'page', the CommIT team advises to keep the following guidelines in mind when contributing.

## Branching Strategy
For branching, we apply the same branching strategy as we use in Koala:
- `feature/` for new features.
- `bug/` for bugfixes.
- `doc/` for documentation.
- `test/` for testing.
- `debt/` for refactoring and enhancements.

## Commit Messages
Please make sure to write descriptive commit messages:
1. The header should be 72 characters or less.
2. Write messages in the imperative: "Fix bug X", "Add feature Y", etc.
3. Reference issue in commit that fixes it: "Fixes #12: Remove bug Z".
4. Add a body to the message in which you elaborate on the header.

## Thanks!
Thank you a lot for any PR's!

0 comments on commit d1c35c2

Please sign in to comment.