From 50fbb8c425d13d8730321d38be0d94c4fe1df4ca Mon Sep 17 00:00:00 2001 From: Jeremy Novey Date: Fri, 24 Jan 2025 14:28:31 -0500 Subject: [PATCH 1/4] Create contribution guide --- CONTRIBUTING.md | 61 ++++++++++++++++++++++++++++++ README.MD | 4 ++ rest-configurations.code-workspace | 8 ++++ 3 files changed, 73 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 rest-configurations.code-workspace diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b805d1a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# How to contribute to the Lucidworks REST Configurations repository + +Contributing to the REST Configurations repository is a great way to improve the REST V2 connector ability and collaborate with the Lucidworks data acquisition community. + +## Prerequisites + +Before contributing, ensure you have the following: + +* A GitHub account. +* Basic knowledge of git and pull requests. +* Necessary development tools installed (for example, Git CLI and a code editor). + +## Steps to contribute + +1. Fork the repository by clicking the *Fork* button in the upper-right corner. The repository will be copied to your GitHub account. +2. Clone your fork. Open a terminal and clone your forked repository: + +``` +git clone https://github.com/YOUR_USERNAME/rest-configurations.git +``` + +2. Navigate into the cloned directory: + +``` +cd rest-configurations +``` + +3. Create a new branch: + +``` +git checkout -b BRANCH_NAME +``` + +4. Make your changes. + +* Open the repository in your code editor. +* Add a new recipe or make other changes. + +5. Stage your changes: + +``` +git add . +``` + +6. Commit your changes with a commit message: + +``` +git commit -m "Add new recipe" +``` + +7. Push your branch to your forked repository: + +``` +git push origin BRANCH_NAME +``` + +8. Open a Pull Request (PR). + +* In this REST Configurations repository, click the *Pull requests* tab and click the blue underlined text that states *compare across forks*. On the right, select your forked repository and branch name. +* Provide a title and description of your changes. +* Submit the PR. \ No newline at end of file diff --git a/README.MD b/README.MD index 6c8cef0..93f941d 100644 --- a/README.MD +++ b/README.MD @@ -17,3 +17,7 @@ curl -u username:password --location 'https://**fusion domain!**/api/apps/**fusi 3. Log in to the Fusion admin and configure the relevant information, such as credentials, URL for the instance, etc. 4. Now you're ready to go! Happy crawling! + +## Contributing + +All are welcome to contribute to this repository. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidance on how to contribute. \ No newline at end of file diff --git a/rest-configurations.code-workspace b/rest-configurations.code-workspace new file mode 100644 index 0000000..876a149 --- /dev/null +++ b/rest-configurations.code-workspace @@ -0,0 +1,8 @@ +{ + "folders": [ + { + "path": "." + } + ], + "settings": {} +} \ No newline at end of file From cb612d3a8c79afa7c22d03f01e41c13cc7e68bc5 Mon Sep 17 00:00:00 2001 From: Jeremy Novey Date: Fri, 24 Jan 2025 14:35:13 -0500 Subject: [PATCH 2/4] Updated PR steps --- CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b805d1a..366a0fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,6 +56,5 @@ git push origin BRANCH_NAME 8. Open a Pull Request (PR). -* In this REST Configurations repository, click the *Pull requests* tab and click the blue underlined text that states *compare across forks*. On the right, select your forked repository and branch name. -* Provide a title and description of your changes. -* Submit the PR. \ No newline at end of file +* In this REST Configurations repository, if you see the yellow box with your branch, click *Compare and pull request*. If you do not see that box, you can click the *Pull requests* tab, click *New pull request*, and use *base: main* along with *compare: YOUR_BRANCH*. +* Submit the PR by clicking *Create pull request*. \ No newline at end of file From 9e84047232a6e43f449281bb5ef373cc70152c3e Mon Sep 17 00:00:00 2001 From: Jeremy Novey Date: Fri, 24 Jan 2025 14:47:53 -0500 Subject: [PATCH 3/4] Ignore file --- rest-configurations.code-workspace | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/rest-configurations.code-workspace b/rest-configurations.code-workspace index 876a149..ef9f5d2 100644 --- a/rest-configurations.code-workspace +++ b/rest-configurations.code-workspace @@ -1,8 +1,7 @@ { - "folders": [ - { - "path": "." - } - ], - "settings": {} + "folders": [ + { + "path": "." + } + ] } \ No newline at end of file From 5054ab35a5043b29ed0f8f511a55fbea6caec383 Mon Sep 17 00:00:00 2001 From: Jeremy Novey Date: Fri, 24 Jan 2025 15:04:56 -0500 Subject: [PATCH 4/4] Remove file --- rest-configurations.code-workspace | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 rest-configurations.code-workspace diff --git a/rest-configurations.code-workspace b/rest-configurations.code-workspace deleted file mode 100644 index ef9f5d2..0000000 --- a/rest-configurations.code-workspace +++ /dev/null @@ -1,7 +0,0 @@ -{ - "folders": [ - { - "path": "." - } - ] -} \ No newline at end of file