Skip to content

Commit 113f3c1

Browse files
committed
Update CONTRIBUTING.md
1 parent be61e95 commit 113f3c1

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

CONTRIBUTING.md

+19-13
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11

2-
# Contributing to style-forge.helpers
2+
# Contributing to Style-Forge.Helpers
33

4-
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.
4+
Thank you for your interest in contributing to the `Style-Forge.Helpers` project! We welcome contributions from the
5+
community. Please follow these guidelines to ensure a smooth contribution process.
56

67
## How to Contribute
78

89
1. **Fork the repository**
9-
- Click the "Fork" button at the top right corner of the repository page on GitHub.
10+
- Click the "Fork" button at the top right corner of the repository page on GitHub.
1011

1112
2. **Clone the forked repository to your local machine**
1213
```bash
13-
git clone https://github.com/your-username/style-forge.helpers.git
14+
git clone https://github.com/Style-Forge/helpers.git
1415
```
1516

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

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

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

36-
## Code Requirements
39+
## Code Style
3740

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

4245
## Reporting Issues
4346

44-
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.
47+
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.
4548

46-
## Suggestions
49+
## Community
4750

48-
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.
51+
- Be respectful and considerate in your communications.
52+
- Follow the project's code of conduct.
53+
54+
For more information, visit our [documentation site](https://style-forge.dev/helpers/).
4955

5056
Thank you for your contributions!

0 commit comments

Comments
 (0)