-
-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
26 changed files
with
2,177 additions
and
2,177 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,47 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve ClaudeSync | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Run command '....' | ||
3. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Error messages** | ||
If applicable, provide the full error message or stack trace. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Environment (please complete the following information):** | ||
- OS: [e.g. Windows 10, macOS 11.4, Ubuntu 20.04] | ||
- Python version: [e.g. 3.8.10] | ||
- ClaudeSync version: [e.g. 0.3.7] | ||
|
||
**Configuration** | ||
Please provide the output of `claudesync config list` (make sure to remove any sensitive information). | ||
|
||
**Additional context** | ||
Add any other context about the problem here. For example: | ||
- Are you using any custom configurations? | ||
- Did this issue start happening recently, or has it always been a problem? | ||
- Can you reliably reproduce this issue? If not, how often does it occur? | ||
|
||
**Logs** | ||
If possible, please provide relevant logs. You can increase the log verbosity by running: | ||
``` | ||
claudesync config set log_level DEBUG | ||
``` | ||
Then reproduce the issue and provide the logs (make sure to remove any sensitive information). | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve ClaudeSync | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Run command '....' | ||
3. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Error messages** | ||
If applicable, provide the full error message or stack trace. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Environment (please complete the following information):** | ||
- OS: [e.g. Windows 10, macOS 11.4, Ubuntu 20.04] | ||
- Python version: [e.g. 3.8.10] | ||
- ClaudeSync version: [e.g. 0.3.7] | ||
|
||
**Configuration** | ||
Please provide the output of `claudesync config list` (make sure to remove any sensitive information). | ||
|
||
**Additional context** | ||
Add any other context about the problem here. For example: | ||
- Are you using any custom configurations? | ||
- Did this issue start happening recently, or has it always been a problem? | ||
- Can you reliably reproduce this issue? If not, how often does it occur? | ||
|
||
**Logs** | ||
If possible, please provide relevant logs. You can increase the log verbosity by running: | ||
``` | ||
claudesync config set log_level DEBUG | ||
``` | ||
Then reproduce the issue and provide the logs (make sure to remove any sensitive information). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,39 @@ | ||
# This workflow will upload a Python Package using Twine when a release is created | ||
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries | ||
|
||
# This workflow uses actions that are not certified by GitHub. | ||
# They are provided by a third-party and are governed by | ||
# separate terms of service, privacy policy, and support | ||
# documentation. | ||
|
||
name: Upload Python Package | ||
|
||
on: | ||
release: | ||
types: [created] | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
deploy: | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Python | ||
uses: actions/setup-python@v3 | ||
with: | ||
python-version: '3.x' | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install build | ||
- name: Build package | ||
run: python -m build | ||
- name: Publish package | ||
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 | ||
with: | ||
user: __token__ | ||
password: ${{ secrets.PYPI_API_TOKEN }} | ||
# This workflow will upload a Python Package using Twine when a release is created | ||
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries | ||
|
||
# This workflow uses actions that are not certified by GitHub. | ||
# They are provided by a third-party and are governed by | ||
# separate terms of service, privacy policy, and support | ||
# documentation. | ||
|
||
name: Upload Python Package | ||
|
||
on: | ||
release: | ||
types: [created] | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
deploy: | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Python | ||
uses: actions/setup-python@v3 | ||
with: | ||
python-version: '3.x' | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install build | ||
- name: Build package | ||
run: python -m build | ||
- name: Publish package | ||
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 | ||
with: | ||
user: __token__ | ||
password: ${{ secrets.PYPI_API_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,84 +1,84 @@ | ||
# Contributing to ClaudeSync | ||
|
||
We're excited that you're interested in contributing to ClaudeSync! This document outlines the process for contributing to this project. | ||
|
||
## Getting Started | ||
|
||
1. Fork the repository on GitHub. | ||
2. Clone your fork locally: | ||
``` | ||
git clone https://github.com/your-username/claudesync.git | ||
``` | ||
3. Create a new branch for your feature or bug fix: | ||
``` | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
## Setting Up the Development Environment | ||
|
||
1. Ensure you have Python 3.6 or later installed. | ||
2. Install the development dependencies: | ||
``` | ||
pip install -r requirements.txt | ||
``` | ||
3. Install the package in editable mode: | ||
``` | ||
pip install -e . | ||
``` | ||
|
||
## Making Changes | ||
|
||
1. Make your changes in your feature branch. | ||
2. Add or update tests as necessary. | ||
3. Run the tests to ensure they pass: | ||
``` | ||
python -m unittest discover tests | ||
``` | ||
4. Update the documentation if you've made changes to the API or added new features. | ||
|
||
## Submitting Changes | ||
|
||
1. Commit your changes: | ||
``` | ||
git commit -am "Add a brief description of your changes" | ||
``` | ||
2. Push to your fork: | ||
``` | ||
git push origin feature/your-feature-name | ||
``` | ||
3. Submit a pull request through the GitHub website. | ||
|
||
## Code Style | ||
|
||
We follow the black style guide for Python code. Please ensure your code adheres to this style. | ||
|
||
## Reporting Bugs | ||
|
||
If you find a bug, please open an issue on the GitHub repository using our bug report template. To do this: | ||
|
||
1. Go to the [Issues](https://github.com/jahwag/claudesync/issues) page of the ClaudeSync repository. | ||
2. Click on "New Issue". | ||
3. Select the "Bug Report" template. | ||
4. Fill out the template with as much detail as possible. | ||
|
||
When reporting a bug, please include: | ||
|
||
- A clear and concise description of the bug | ||
- Steps to reproduce the behavior | ||
- Expected behavior | ||
- Any error messages or stack traces | ||
- Your environment details (OS, Python version, ClaudeSync version) | ||
- Your ClaudeSync configuration (use `claudesync config list`) | ||
- Any relevant logs (you can increase log verbosity with `claudesync config set log_level DEBUG`) | ||
|
||
The more information you provide, the easier it will be for us to reproduce and fix the bug. | ||
|
||
## Requesting Features | ||
|
||
If you have an idea for a new feature, please open an issue on the GitHub repository. Describe the feature and why you think it would be useful for the project. | ||
|
||
## Questions | ||
|
||
If you have any questions about contributing, feel free to open an issue for discussion. | ||
|
||
# Contributing to ClaudeSync | ||
|
||
We're excited that you're interested in contributing to ClaudeSync! This document outlines the process for contributing to this project. | ||
|
||
## Getting Started | ||
|
||
1. Fork the repository on GitHub. | ||
2. Clone your fork locally: | ||
``` | ||
git clone https://github.com/your-username/claudesync.git | ||
``` | ||
3. Create a new branch for your feature or bug fix: | ||
``` | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
## Setting Up the Development Environment | ||
|
||
1. Ensure you have Python 3.6 or later installed. | ||
2. Install the development dependencies: | ||
``` | ||
pip install -r requirements.txt | ||
``` | ||
3. Install the package in editable mode: | ||
``` | ||
pip install -e . | ||
``` | ||
|
||
## Making Changes | ||
|
||
1. Make your changes in your feature branch. | ||
2. Add or update tests as necessary. | ||
3. Run the tests to ensure they pass: | ||
``` | ||
python -m unittest discover tests | ||
``` | ||
4. Update the documentation if you've made changes to the API or added new features. | ||
|
||
## Submitting Changes | ||
|
||
1. Commit your changes: | ||
``` | ||
git commit -am "Add a brief description of your changes" | ||
``` | ||
2. Push to your fork: | ||
``` | ||
git push origin feature/your-feature-name | ||
``` | ||
3. Submit a pull request through the GitHub website. | ||
|
||
## Code Style | ||
|
||
We follow the black style guide for Python code. Please ensure your code adheres to this style. | ||
|
||
## Reporting Bugs | ||
|
||
If you find a bug, please open an issue on the GitHub repository using our bug report template. To do this: | ||
|
||
1. Go to the [Issues](https://github.com/jahwag/claudesync/issues) page of the ClaudeSync repository. | ||
2. Click on "New Issue". | ||
3. Select the "Bug Report" template. | ||
4. Fill out the template with as much detail as possible. | ||
|
||
When reporting a bug, please include: | ||
|
||
- A clear and concise description of the bug | ||
- Steps to reproduce the behavior | ||
- Expected behavior | ||
- Any error messages or stack traces | ||
- Your environment details (OS, Python version, ClaudeSync version) | ||
- Your ClaudeSync configuration (use `claudesync config list`) | ||
- Any relevant logs (you can increase log verbosity with `claudesync config set log_level DEBUG`) | ||
|
||
The more information you provide, the easier it will be for us to reproduce and fix the bug. | ||
|
||
## Requesting Features | ||
|
||
If you have an idea for a new feature, please open an issue on the GitHub repository. Describe the feature and why you think it would be useful for the project. | ||
|
||
## Questions | ||
|
||
If you have any questions about contributing, feel free to open an issue for discussion. | ||
|
||
Thank you for your interest in improving ClaudeSync! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,21 @@ | ||
MIT License | ||
Copyright (c) 2024 Jahziah Wagner | ||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. | ||
MIT License | ||
|
||
Copyright (c) 2024 Jahziah Wagner | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
Oops, something went wrong.