Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (34 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 1.59 KB

Contributing to Zep

Thank you for your interest in contributing to Zep! We appreciate your efforts and look forward to collaborating with you.

Getting Started

  1. Fork and Clone: Start by forking the Zep repo. Then, clone your fork locally:
git clone https://github.com/<your-github-username>/zep.git
  1. Set Upstream: Keep your fork synced with the upstream repo by adding it as a remote:
git remote add upstream https://github.com/getzep/zep.git
  1. Create a Feature Branch: Always create a new branch for your work. This helps in keeping your changes organized and easier for maintainers to review.
git checkout -b feature/your-feature-name

Submitting Changes

  1. Commit Your Changes: Use meaningful commit messages that describe the changes made.
git add .
git commit -m "Your detailed commit message"
  1. Push to Your Fork:
git push origin feature/your-feature-name
  1. Open a Pull Request: Navigate to the Zep GitHub repo and click on "New pull request". Choose your fork and the branch you've been working on. Submit the PR with a descriptive message.

Feedback

Maintainers will review your PR and provide feedback. If any changes are needed, make them in your feature branch and push to your fork. The PR will update automatically.

Final Notes

  • Always be respectful and kind.
  • If you're unsure about something, ask. We're here to help.
  • Once again, thank you for contributing to Zep!

If you encounter any issues or have suggestions, please open an issue!