Skip to content

Commit

Permalink
chore: restructure for semantic chunkers
Browse files Browse the repository at this point in the history
  • Loading branch information
jamescalam committed Apr 30, 2024
1 parent 29762f0 commit ceff38f
Show file tree
Hide file tree
Showing 110 changed files with 215 additions and 22,075 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Aurelio Team welcome and encourage any contributions to the Semantic Router, big or small. Please feel free to contribute to new features, bug fixes, or documentation. We're always eager to hear your suggestions.

Please follow these guidelines when making a contribution:
1. **Check for Existing Issues:** Before making any changes, [check here for related issues](https://github.com/aurelio-labs/semantic-router/issues).
1. **Check for Existing Issues:** Before making any changes, [check here for related issues](https://github.com/aurelio-labs/semantic-chunkers/issues).
2. **Run Your Changes by Us!** If no related issue exists yet, please create one and suggest your changes. Checking in with the team first will allow us to determine if the changes are in scope.
3. **Set Up Development Environment** If the changes are agreed, then you can go ahead and set up a development environment (see [Setting Up Your Development Environment](#setting-up-your-development-environment) below).
4. **Create an Early Draft Pull Request** Once you have commits ready to be shared, initiate a draft Pull Request with an initial version of your implementation and request feedback. It's advisable not to wait until the feature is fully completed.
Expand All @@ -25,14 +25,14 @@ While we encourage you to initiate a draft Pull Request early to get feedback on
# Setting Up Your Development Environment

1. Fork on GitHub:
Go to the [repository's page](https://github.com/aurelio-labs/semantic-router) on GitHub:
Go to the [repository's page](https://github.com/aurelio-labs/semantic-chunkers) on GitHub:
Click the "Fork" button in the top-right corner of the page.
2. Clone Your Fork:
After forking, you'll be taken to your new fork of the repository on GitHub. Copy the URL of your fork from the address bar or by clicking the "Code" button and copying the URL under "Clone with HTTPS" or "Clone with SSH".
Open your terminal or command prompt.
Use the git clone command followed by the URL you copied to clone the repository to your local machine. Replace `https://github.com/<your-gh-username>/<semantic-router>.git` with the URL of your fork:
Use the git clone command followed by the URL you copied to clone the repository to your local machine. Replace `https://github.com/<your-gh-username>/<semantic-chunkers>.git` with the URL of your fork:
```
git clone https://github.com/<your-gh-username>/<semantic-router>.git
git clone https://github.com/<your-gh-username>/<semantic-chunkers>.git
```
3. Ensure you have poetry installed: `pip install poetry`.
4. Then navigate to the cloned folder, create a virtualenv, and install via poetry (which defaults to an editable installation):
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Aurelio AI
Copyright (c) 2024 Aurelio AI

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
Loading

0 comments on commit ceff38f

Please sign in to comment.