Skip to content

Commit

Permalink
docs: provide a readme guide with a set of instructions and examples (#…
Browse files Browse the repository at this point in the history
…25)

* docs: provide installation guide

* chore: rename PR Checks workflow to Build and update README

* docs: update CONTRIBUTING.md to clarify commit message format
  • Loading branch information
shettayyy authored Oct 27, 2024
1 parent 1a52f27 commit b22454c
Show file tree
Hide file tree
Showing 3 changed files with 447 additions and 55 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/pr-checks.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: PR Checks
name: Build

on:
pull_request:
Expand Down
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

We're excited that you're interested in contributing to Class Glue! This document outlines the process for contributing to this project. Whether you're fixing bugs, improving documentation, or adding new features, your contributions are welcome.

**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://kcd.im/pull-request)

## Getting Started

1. Fork the repository on GitHub.
Expand Down Expand Up @@ -42,7 +44,7 @@ We're excited that you're interested in contributing to Class Glue! This documen
4. Commit your changes:

```bash
git commit -m "Your descriptive commit message"
git commit -m "feat: your descriptive commit message"
```

5. Push to your fork:
Expand Down Expand Up @@ -95,8 +97,4 @@ Choose the template that best fits your contribution type. If you're unsure, use
- Clearly describe the feature and its potential benefits.
- Be open to discussion about the feature's implementation.

## Code of Conduct

By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).

Thank you for contributing to Class-Glue!
Loading

0 comments on commit b22454c

Please sign in to comment.