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
So, you want to contribute to this project? That's awesome! However, before doing so, please read the following simple steps on how to contribute. This will make life easier and avoid wasting time on things that are not requested. ✨
3
+
Want to contribute to this project? Great! Please read these quick steps to streamline the process and avoid unnecessary tasks. ✨
4
4
5
-
## Discuss the changes before making them
6
-
To begin, open an issue in the repository using the [bug tracker][1]. Describe the contribution you'd like to make, the bug you've found, or any other ideas you have. This step will help us get you started on the right track.
5
+
## 💬 Discuss Changes
6
+
Start by opening an issue in the repository using the [bug tracker][1]. Describe your proposed contribution or the bug you've found. If relevant, include platform info and screenshots. 🖼️
7
7
8
-
If it is relevant, include platform and software information (e.g., operating system, Node.JS version, etc.) and screenshots to help us understand what you're experiencing.
8
+
Wait for feedback before proceeding unless the fix is straightforward, like a typo. 📝
9
9
10
-
We recommend waiting for feedback before proceeding to the next steps. However, if the issue is clear, such as a typo, and the fix is simple, you can go ahead and fix it.
10
+
## 🔧 Fixing Issues
11
11
12
-
## Fixing Issues
13
-
Begin by forking the project to your own account, and create a branch for your fix, naming it either `some-great-feature` or `some-issue-fix`.
12
+
Fork the project and create a branch for your fix, naming it `some-great-feature` or `some-issue-fix`. Commit changes while following the [code style][2]. If the project has tests, add one. ✅
14
13
15
-
Commit your changes to that branch, adhering to the [code style][2]. If the project includes tests (usually located in the `test` directory), we encourage you to add a test as well. :memo:
16
-
17
-
If the project includes a `package.json` or a `bower.json` file, add yourself to the `contributors` array (or `authors` in the case of `bower.json`). If the array doesn't exist, create it as shown below:
14
+
If a `package.json` or `bower.json` exists, add yourself to the `contributors` array; create it if it doesn't. 🙌
18
15
19
16
```json
20
17
{
@@ -24,18 +21,16 @@ If the project includes a `package.json` or a `bower.json` file, add yourself to
24
21
}
25
22
```
26
23
27
-
## Creating a Pull Request
28
-
Start by opening a pull request and make sure to reference the initial issue in the pull request message (e.g., *fixes #<your-issue-number>*). Provide a clear and descriptive title to help everyone understand what is being fixed or improved.
29
-
30
-
If applicable, consider adding screenshots, gifs, or any other visual aids that can make it easier to understand the changes you've made.
24
+
## 📬 Creating a Pull Request
25
+
Open a pull request and reference the initial issue (e.g., *fixes #<your-issue-number>*). Provide a clear title and consider adding visual aids for clarity. 📊
31
26
32
-
## Wait for Feedback
33
-
Before accepting your contributions, we will review them. You may receive feedback regarding what needs to be addressed in your modified code. If so, simply continue making commits to your branch, and the pull request will be automatically updated.
27
+
## ⏳ Wait for Feedback
28
+
Your contributionswill be reviewed. If feedback is given, update your branch as needed, and the pull request will auto-update. 🔄
34
29
35
-
## Everyone Is Happy!
36
-
Ultimately, your contributions will be merged, and everyone will be delighted! 😄 Contributions are more than welcome!
30
+
## 🎉 Everyone Is Happy!
31
+
Your contributions will be merged, and everyone will appreciate your effort! 😄❤️
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@
21
21
22
22
# git-url-parse
23
23
24
-
[![Support me on Patreon][badge_patreon]][patreon][![Buy me a book][badge_amazon]][amazon][![PayPal][badge_paypal_donate]][paypal-donations][](https://github.com/IonicaBizau/ama)[](https://travis-ci.org/IonicaBizau/git-url-parse/)[](https://www.npmjs.com/package/git-url-parse)[](https://www.npmjs.com/package/git-url-parse)[](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
24
+
[![Support me on Patreon][badge_patreon]][patreon][![Buy me a book][badge_amazon]][amazon][![PayPal][badge_paypal_donate]][paypal-donations][](https://github.com/IonicaBizau/ama)[](https://travis-ci.org/IonicaBizau/git-url-parse/)[](https://www.npmjs.com/package/git-url-parse)[](https://www.npmjs.com/package/git-url-parse)[](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
25
25
26
26
<ahref="https://www.buymeacoffee.com/H96WwChMy"target="_blank"><imgsrc="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png"alt="Buy Me A Coffee"></a>
27
27
@@ -305,8 +305,6 @@ If you are using this library in one of your projects, add it in this list. :spa
305
305
-`@backstage/plugin-techdocs-node`
306
306
-`@belt/repo`
307
307
-`@blackglory/git-list`
308
-
-`@brainfried/github-books`
309
-
-`@brantalikp/rn-resize`
310
308
-`@brisk-docs/gatsby-generator`
311
309
-`@brisk-docs/website`
312
310
-`@buschtoens/documentation`
@@ -323,15 +321,16 @@ If you are using this library in one of your projects, add it in this list. :spa
323
321
-`@deskbtm/workspace-tools`
324
322
-`@dfatwork-pkgs/backstage-cli`
325
323
-`@dougkulak/semantic-release-gh-pages-plugin`
324
+
-`@drakedeatonuk/rschedule`
326
325
-`@dtwo/telemetry`
327
326
-`@eat-fish/changelog`
328
327
-`@emedvedev/renovate`
329
328
-`@enkeledi/react-native-week-month-date-picker`
329
+
-`@env0/backstage-plugin-env0`
330
330
-`@era-ci/utils`
331
331
-`@erquhart/lerna-github-client`
332
332
-`@esops/publish-github-pages`
333
333
-`@eteg/nextra-theme-docs`
334
-
-`@evanpurkhiser/tooling-personal`
335
334
-`@facadecompany/ignition-ui`
336
335
-`@feizheng/next-git-url`
337
336
-`@felipesimmi/react-native-datalogic-module`
@@ -348,6 +347,7 @@ If you are using this library in one of your projects, add it in this list. :spa
348
347
-`@hawkingnetwork/react-native-tab-view`
349
348
-`@hbglobal/react-native-actions-shortcuts`
350
349
-`@hemith/react-native-tnk`
350
+
-`@holipoly/cli`
351
351
-`@hugomrdias/documentation`
352
352
-`@hygiene/plugin-github-url`
353
353
-`@iceworks/project-utils`
@@ -358,11 +358,9 @@ If you are using this library in one of your projects, add it in this list. :spa
358
358
-`@jswork/topics2keywords`
359
359
-`@kadira/storybook-deployer`
360
360
-`@kevinbds/techdocs-common`
361
-
-`@kgit/readability`
362
361
-`@kgit/readbility`
363
362
-`@koumoul/gh-pages-multi`
364
363
-`@labiebhn_/react-native-multiplier`
365
-
-`@lacymorrow/nextra-theme-docs`
366
364
-`@lehuyaa/my-assets`
367
365
-`@lerna-lite/version`
368
366
-`@lerna-test-v1/markdown`
@@ -379,17 +377,18 @@ If you are using this library in one of your projects, add it in this list. :spa
379
377
-`@monokle/synchronizer`
380
378
-`@narfeta/catalog-backend`
381
379
-`@navabi/react-native-ssl-pinning`
380
+
-`@nuxt/content`
382
381
-`@nuxt/telemetry`
383
382
-`@nuxt/ui-pro`
384
383
-`@nuxthq/studio`
385
-
-`@oiti/rn-liveness2d`
386
384
-`@oumi/block-sdk`
387
385
-`@oumi/cli-ui`
388
386
-`@pageshare/cli`
389
387
-`@parallelnft/web3modal`
390
388
-`@pipelinedoc/cli`
391
389
-`@plone/scripts`
392
390
-`@pmworks/project-utils`
391
+
-`@polearn/core`
393
392
-`@positionex/position-sdk`
394
393
-`@praella/localisationist`
395
394
-`@pubbo/github-client`
@@ -404,6 +403,8 @@ If you are using this library in one of your projects, add it in this list. :spa
0 commit comments