You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTIONS.md
+36-31Lines changed: 36 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Contributing to React SearchBar Component
1
+
# Contributing to React API Search
2
2
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.
4
4
5
5
## How to Contribute
6
6
@@ -12,19 +12,11 @@ There are several ways you can contribute to this project:
12
12
4.**Update Documentation**
13
13
5.**Improve Tests**
14
14
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:
2.Since the library cannot run as a standalone app, use \`npm link\` to test it in a separate project:
39
31
40
32
```bash
41
-
npm start
33
+
npm link
42
34
```
43
35
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:
45
37
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:
47
52
48
53
```bash
49
54
npm test
50
55
```
51
56
52
57
## Making Changes
53
58
54
-
1.**Create a new branch**:
59
+
1.**Create a new branch**:
55
60
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.
56
61
57
62
```bash
58
63
git checkout -b feature-name
59
64
```
60
65
61
-
2.**Make your changes**:
66
+
2.**Make your changes**:
62
67
Edit the necessary files, and follow the existing code style and conventions.
63
68
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.
66
71
67
-
4.**Commit your changes**:
72
+
4.**Commit your changes**:
68
73
Commit your changes with a clear, concise message that explains the purpose of your modification.
69
74
70
75
```bash
71
76
git add .
72
77
git commit -m "Add feature XYZ"
73
78
```
74
79
75
-
5.**Push your changes**:
80
+
5.**Push your changes**:
76
81
Push your branch to your forked repository.
77
82
78
83
```bash
79
84
git push origin feature-name
80
85
```
81
86
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.
84
89
85
90
## Code Style
86
91
@@ -117,21 +122,21 @@ Example commit message format:
117
122
118
123
## Reporting Issues
119
124
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:
121
126
122
127
- A clear description of the problem.
123
128
- Steps to reproduce the issue.
124
129
- Expected vs. actual behavior.
125
130
- Any relevant error messages or logs.
126
131
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
-
131
132
## License
132
133
133
134
By contributing to this project, you agree that your contributions will be licensed under the project’s [MIT License](LICENSE).
134
135
135
136
---
136
137
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. 🚀
0 commit comments