Skip to content

Commit

Permalink
docs: Formatting in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
saattrupdan committed Nov 26, 2024
1 parent 6dc9b57 commit 9e05606
Showing 1 changed file with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to {{ cookiecutter.project_name }} contributing guide
# {{ cookiecutter.project_name | replace("_", " ") | title }} Contributing Guide

Thank you for investing your time in contributing to our project! :sparkles:.

Expand All @@ -9,7 +9,7 @@ In this guide you will get an overview of the contribution workflow from opening
issue, creating a PR, reviewing, and merging the PR.


## New contributor guide
## New Contributor Guide

To get an overview of the project, read the [README](README.md). Here are some
resources to help you get started with open source contributions:
Expand All @@ -20,18 +20,18 @@ resources to help you get started with open source contributions:
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)


## Getting started
## Getting Started

### Issues

#### Create a new issue
#### Create a New Issue

If you spot a problem with the package, [search if an issue already
exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments).
If a related issue doesn't exist, you can open a new issue using a relevant [issue
form](https://github.com/alexandrainst/{{ cookiecutter.project_name }}/issues).

#### Solve an issue
#### Solve an Issue

Scan through our [existing issues](https://github.com/alexandrainst/{{ cookiecutter.project_name }}/issues)
to find one that interests you. You can narrow down the search using `labels` as
Expand All @@ -52,7 +52,7 @@ find an issue to work on, you are welcome to open a PR with a fix.

4. Create a working branch and start with your changes!

### Commit your update
### Commit Your Update

Commit the changes once you are happy with them. See [Atom's contributing
guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) to
Expand Down Expand Up @@ -87,4 +87,4 @@ questions or request for additional information.

### Your PR is merged!

Congratulations :tada::tada: The {{ cookiecutter.project_name }} team thanks you :sparkles:.
Congratulations :tada::tada: The {{ cookiecutter.project_name | replace("_", " ") | title }} team thanks you :sparkles:.

0 comments on commit 9e05606

Please sign in to comment.