Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sarmaged committed Jul 21, 2024
1 parent be61e95 commit 113f3c1
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@

# Contributing to style-forge.helpers
# Contributing to Style-Forge.Helpers

Thank you for your interest in contributing to the Style Forge Helpers project! We welcome contributions from the community. Please follow these guidelines to ensure a smooth contribution process.
Thank you for your interest in contributing to the `Style-Forge.Helpers` project! We welcome contributions from the
community. Please follow these guidelines to ensure a smooth contribution process.

## How to Contribute

1. **Fork the repository**
- Click the "Fork" button at the top right corner of the repository page on GitHub.
- Click the "Fork" button at the top right corner of the repository page on GitHub.

2. **Clone the forked repository to your local machine**
```bash
git clone https://github.com/your-username/style-forge.helpers.git
git clone https://github.com/Style-Forge/helpers.git
```

3. **Create a new branch for your changes**
Expand All @@ -19,7 +20,7 @@ Thank you for your interest in contributing to the Style Forge Helpers project!
```

4. **Make your changes and commit them**
- Please ensure that your commits have descriptive messages.
- Please ensure that your commits have descriptive messages.
```bash
git commit -am 'Add some feature'
```
Expand All @@ -31,20 +32,25 @@ Thank you for your interest in contributing to the Style Forge Helpers project!

6. **Create a pull request**
- Go to the page of your forked repository on GitHub.
- Click the "New pull request" button and follow the instructions.
- Click the "New pull request" button.
- Select the base repository and branch you want to merge your changes into.
- Provide a clear and detailed description of your changes.

## Code Requirements
## Code Style

- **Coding Style**: Please follow the existing coding style.
- **Tests**: Ensure that your code passes all tests.
- **Documentation**: Update the documentation if necessary.
- Please ensure your code follows the project's coding standards.
- Run existing tests to make sure your changes do not break anything.
- If applicable, add new tests to cover your changes.

## Reporting Issues

If you find a bug, please create a [new issue](https://github.com/Sarmaged/style-forge.helpers/issues) describing the problem and the steps to reproduce it.
If you find a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible to help us understand and address the issue.

## Suggestions
## Community

If you have ideas for improvements, please create a [new issue](https://github.com/Sarmaged/style-forge.helpers/issues) with a detailed description of your idea.
- Be respectful and considerate in your communications.
- Follow the project's code of conduct.

For more information, visit our [documentation site](https://style-forge.dev/helpers/).

Thank you for your contributions!

0 comments on commit 113f3c1

Please sign in to comment.