Skip to content

Commit

Permalink
chore: Add CONTRIBUTING.md (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
simenandre authored Sep 13, 2022
1 parent d996075 commit 290a2fc
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing to Pulumiverse

:+1::tada: Thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing. These are just
guidelines, not rules, so use your best judgement and feel free to propose
changes to this document in a pull request.

## Issues and Pull Requests

- If you're not sure about adding something, open an issue to discuss it.
- Feel free to open a Pull Request early so that a discussion can be had as
changes are developed.

## Commit Messages and Pull Request Titles

We use the
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
specification to standardize our commit history. To encourage this convention on
commit messages and/or pull request titles, we use the
[Semantic Pull Requests](https://github.com/probot/semantic-pull-requests) bot.

The commit message summary (or pull request title) is constructed by prepending
the type of change being made (e.g., feat, fix, refactor), followed by an
imperative, present tense sentence (without a period). Example:
`fix: make header bold`.

If you are still working on your pull request, prepend `WIP:` to indicate that
it's work in progress or use the draft pull requests feature.

### Pull Request Title

Same as commit messages, prepend the type of change being made (refactor, fix,
chore, feat, etc.) Example: `docs: add linux setup instructions`

## Need Help?

If any of this information confusing, incorrect, or incomplete, feel free to
join the [Pulumi Community slack][pulumi-slack] and our channel #pulumiverse for help.

[pulumi-slack]: https://slack.pulumi.com/

0 comments on commit 290a2fc

Please sign in to comment.