Skip to content

Commit d8cf8cd

Browse files
committed
contributions fixes
1 parent 3e7c063 commit d8cf8cd

File tree

1 file changed

+36
-31
lines changed

1 file changed

+36
-31
lines changed

CONTRIBUTIONS.md

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to React SearchBar Component
1+
# Contributing to React API Search
22

3-
Thank you for considering contributing to the **Type Search Api**! We welcome contributions from the community and appreciate your interest in improving this project.
3+
Thank you for considering contributing to **React API Search**! We welcome contributions from the community and appreciate your interest in improving this project.
44

55
## How to Contribute
66

@@ -12,19 +12,11 @@ There are several ways you can contribute to this project:
1212
4. **Update Documentation**
1313
5. **Improve Tests**
1414

15-
## Prerequisites
16-
17-
Before you start, make sure you have the following installed:
18-
19-
- [Node.js](https://nodejs.org/) (LTS version recommended)
20-
- [npm](https://www.npmjs.com/) (comes with Node.js)
21-
22-
If you're new to this project, fork the repository and clone your fork to your local machine:
15+
# Fork the repository on GitHub and clone it
2316

2417
```bash
25-
# Fork the repository on GitHub and clone it
26-
git clone https://github.com/YOUR-USERNAME/react-searchbar-component.git
27-
cd react-searchbar-component
18+
git clone https://github.com/ghosnkarl/react-api-search.git
19+
cd react-api-search
2820
```
2921

3022
## Setting Up the Development Environment
@@ -35,52 +27,65 @@ cd react-searchbar-component
3527
npm install
3628
```
3729

38-
2. Start the development server:
30+
2. Since the library cannot run as a standalone app, use \`npm link\` to test it in a separate project:
3931

4032
```bash
41-
npm start
33+
npm link
4234
```
4335

44-
This will run the app in development mode. Open `http://localhost:3000` to view the project.
36+
3. In your test project (e.g., a React app where you want to test the library), link the library:
4537

46-
3. To run tests:
38+
```bash
39+
cd path-to-your-test-project
40+
npm link react-api-search
41+
```
42+
43+
4. Now, import the library in your test project and test the functionality.
44+
45+
5. To unlink after testing:
46+
47+
```bash
48+
npm unlink react-api-search
49+
```
50+
51+
6. To run tests:
4752

4853
```bash
4954
npm test
5055
```
5156

5257
## Making Changes
5358

54-
1. **Create a new branch**:
59+
1. **Create a new branch**:
5560
Always create a new branch for your changes. Use a descriptive name for the branch that reflects the feature or bug you're working on.
5661

5762
```bash
5863
git checkout -b feature-name
5964
```
6065

61-
2. **Make your changes**:
66+
2. **Make your changes**:
6267
Edit the necessary files, and follow the existing code style and conventions.
6368

64-
3. **Write tests** (if applicable):
65-
If your change involves new functionality or fixes a bug, please add tests. We use [Jest](https://jestjs.io/) for testing, and it's important to ensure that your changes are covered by tests.
69+
3. **Write tests** (if applicable):
70+
If your change involves new functionality or fixes a bug, please add tests. The project uses [Jest](https://jestjs.io/) for testing.
6671

67-
4. **Commit your changes**:
72+
4. **Commit your changes**:
6873
Commit your changes with a clear, concise message that explains the purpose of your modification.
6974

7075
```bash
7176
git add .
7277
git commit -m "Add feature XYZ"
7378
```
7479

75-
5. **Push your changes**:
80+
5. **Push your changes**:
7681
Push your branch to your forked repository.
7782

7883
```bash
7984
git push origin feature-name
8085
```
8186

82-
6. **Open a Pull Request**:
83-
Go to the [GitHub repository](https://github.com/YOUR-USERNAME/react-searchbar-component) and open a pull request (PR). Describe the changes you've made and the reason for them.
87+
6. **Open a Pull Request**:
88+
Go to the [GitHub repository](https://github.com/ghosnkarl/react-api-search) and open a pull request (PR). Describe the changes you've made and the reason for them.
8489

8590
## Code Style
8691

@@ -117,21 +122,21 @@ Example commit message format:
117122

118123
## Reporting Issues
119124

120-
If you find a bug or issue, please report it by opening a new issue in the [Issues section](https://github.com/YOUR-USERNAME/react-searchbar-component/issues) of the repository. When submitting an issue, please provide:
125+
If you find a bug or issue, please report it by opening a new issue in the [Issues section](https://github.com/ghosnkarl/react-api-search/issues) of the repository. When submitting an issue, please provide:
121126

122127
- A clear description of the problem.
123128
- Steps to reproduce the issue.
124129
- Expected vs. actual behavior.
125130
- Any relevant error messages or logs.
126131

127-
## Code of Conduct
128-
129-
By participating in this project, you agree to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to treat others with respect and kindness.
130-
131132
## License
132133

133134
By contributing to this project, you agree that your contributions will be licensed under the project’s [MIT License](LICENSE).
134135

135136
---
136137

137-
Thank you for contributing! Together, we can make the **React SearchBar Component** even better. 🚀
138+
Thank you for contributing! Together, we can make **React API Search** even better. 🚀
139+
140+
```
141+
142+
```

0 commit comments

Comments
 (0)