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
-**[Testing and Debugging Your Regex Patterns](#testing-and-debugging-your-regex-patterns)**
50
+
-**[Contributing to EloquentRegex](#contributing-to-eloquenttegex)**
51
+
-**[Support](#support)**
49
52
50
53
# Overview
51
54
@@ -1020,6 +1023,74 @@ _Note: For debuging `get` method, open "Flags" dropdown and mark "global"_
1020
1023
1021
1024
Testing and debugging are critical steps in ensuring your regex patterns do exactly what you intend. By leveraging the `toRegex()` method and tools like Regexr, you can make this process more manageable and efficient, leading to more accurate and reliable regex implementations in your Laravel applications.
1022
1025
1026
+
# Contributing to EloquentRegex
1027
+
1028
+
We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your help makes EloquentRegex even better for everyone. We follow the classic GitHub contribution flow. Here's how you can get involved:
1029
+
1030
+
### Getting Started
1031
+
1032
+
1.**Fork the Repository:** Start by forking the EloquentRegex repository to your own GitHub account. This creates a personal copy for you to experiment with.
1033
+
1034
+
2.**Clone Your Fork:** Clone your forked repository to your local machine to start making changes. Use the following command, replacing YOUR_USERNAME with your GitHub username:
3.**Set Up Your Environment:** Make sure you have a working Laravel environment to test your changes against. Follow the setup instructions in the project README to get started.
1041
+
1042
+
### Making Changes
1043
+
1044
+
1.**Create a New Branch:** For each set of changes or new feature, create a new branch in your local repository. This keeps your work organized and separate from the main codebase.
1045
+
1046
+
```bash
1047
+
git checkout -b feature/my-new-feature
1048
+
```
1049
+
1050
+
2.**Make Your Changes:** Implement your fixes, features, or documentation updates. Keep your changes focused and contained to the issue at hand for easier review.
1051
+
1052
+
3.**Commit Your Changes:** Once you're satisfied with your work, commit the changes to your branch. Write clear, concise commit messages that explain the changes made.
1053
+
1054
+
```bash
1055
+
git commit -am "Add a brief description of your changes"
1056
+
```
1057
+
1058
+
4.**Push to Your Fork:** Push your branch and changes to your fork on GitHub.
1059
+
1060
+
```bash
1061
+
git push origin feature/my-new-feature
1062
+
```
1063
+
1064
+
### Submitting a Pull Request
1065
+
1066
+
**Pull Request (PR):** Navigate to the original EloquentRegex repository on GitHub. You'll see an option to "Compare & pull request" for your branch. Click it to begin the process of submitting a PR.
1067
+
1068
+
**Describe Your Changes:** Provide a detailed description of the changes in the PR. Include any relevant issue numbers. Explaining the reasoning behind the changes and how they improve EloquentRegex will help reviewers understand your contribution.
1069
+
1070
+
**Submit for Review:** Once your PR is ready and all checks pass, submit it for review. At least one review from the project maintainers is required for merging. Be open to feedback and ready to make further tweaks based on suggestions.
1071
+
1072
+
### Review and Merge
1073
+
1074
+
-**Collaboration:** The project maintainers will review your PR. This process may involve some back-and-forth discussions, additional commits, and updates to your PR based on feedback.
1075
+
1076
+
-**Merge:** Once your PR is approved, a project maintainer will merge it into the main codebase. Congratulations, you've contributed to EloquentRegex!
1077
+
1078
+
### Check Out STRUCTURE.md
1079
+
1080
+
For more detailed information on the project structure and guidelines for contributing, please refer to the [STRUCTURE.md](https://github.com/MaestroError/eloquent-regex/blob/update-documentation-and-add-advanced-usage-section/STRUCTURE.md) file in the repository. It outlines the architecture of EloquentRegex and provides insights into naming conventions, file organization, and other best practices.
1081
+
1082
+
Thank you for considering contributing to EloquentRegex! Your efforts help improve the tool for developers everywhere ❤️.
1083
+
1084
+
# Support
1085
+
1086
+
Support Our Work? 🌟 You can help us keep the code flowing by making a small donation. Every bit of support goes a long way in maintaining and improving our open-source contributions. Click the button below to contribute. Thank you for your generosity!
0 commit comments