Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs 5856 contributing #6

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# 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, 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*.
4 changes: 4 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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.