Skip to content

Commit 0d58aa3

Browse files
committed
docs: Add contributing guide
1 parent ba58682 commit 0d58aa3

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed

CONTRIBUTING.md

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Contributing to fetchff
2+
3+
Thank you for your interest in contributing to the `fetchff` package! Your contributions help improve the library and make it better for everyone. This document outlines how to contribute to the project.
4+
5+
## Table of Contents
6+
7+
- [Getting Started](#getting-started)
8+
- [Reporting Issues](#reporting-issues)
9+
- [Feature Requests](#feature-requests)
10+
- [Submitting Code Changes](#submitting-code-changes)
11+
- [Code Style Guidelines](#code-style-guidelines)
12+
- [Testing](#testing)
13+
- [Documentation](#documentation)
14+
- [Code of Conduct](#code-of-conduct)
15+
16+
## Getting Started
17+
18+
1. **Fork the Repository**: Click the "Fork" button on the top right of the repository page to create your copy of the repository.
19+
2. **Clone Your Fork**: Clone your forked repository to your local machine using:
20+
```bash
21+
git clone https://github.com/your-username/fetchff.git
22+
cd fetchff
23+
```
24+
3. **Install Dependencies**: Install the necessary dependencies for the project:
25+
```bash
26+
npm install
27+
```
28+
29+
## Reporting Issues
30+
31+
If you encounter any bugs or issues, please report them using the following steps:
32+
33+
1. Check the existing issues to see if your problem has already been reported.
34+
2. If not, create a new issue and provide as much detail as possible, including:
35+
- A clear and descriptive title
36+
- Steps to reproduce the issue
37+
- Expected vs. actual behavior
38+
- Environment details (OS, Node.js version, etc.)
39+
40+
## Feature Requests
41+
42+
We welcome feature requests! If you have an idea for a new feature:
43+
44+
1. Check the existing issues to see if your feature has already been suggested.
45+
2. If not, create a new issue with the following information:
46+
- A clear title and description of the feature
47+
- Use cases for the feature and why it's valuable
48+
49+
## Submitting Code Changes
50+
51+
To contribute code changes:
52+
53+
1. **Create a New Branch**: Always create a new branch for your feature or bug fix:
54+
```bash
55+
git checkout -b my-feature-branch
56+
```
57+
2. **Make Your Changes**: Implement your changes and ensure they work as expected.
58+
3. **Commit Your Changes**: Write clear and descriptive commit messages:
59+
```bash
60+
git commit -m "Add feature: Description of the feature"
61+
```
62+
4. **Push to Your Fork**: Push your changes to your fork:
63+
```bash
64+
git push origin my-feature-branch
65+
```
66+
5. **Open a Pull Request**: Go to the original repository and open a pull request. Provide a clear description of the changes you made and why they should be merged.
67+
68+
## Code Style Guidelines
69+
70+
Please follow these guidelines when contributing:
71+
72+
- Use consistent indentation (spaces vs. tabs).
73+
- Write clear and concise code with meaningful variable names.
74+
- Keep your code clean and well-structured.
75+
76+
## Testing
77+
78+
Before submitting your changes, ensure that all tests pass:
79+
80+
1. Run the test suite using:
81+
```bash
82+
npm test
83+
```
84+
2. If you add new features, please include appropriate tests.
85+
86+
## Documentation
87+
88+
If you add new features or make significant changes, please update the documentation accordingly. Ensure that all new functionality is clearly explained.
89+
90+
## Code of Conduct
91+
92+
By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to be respectful and considerate to others.
93+
94+
---
95+
96+
Thank you for your contributions! We appreciate your help in making `fetchff` better.

0 commit comments

Comments
 (0)