First off, thank you for considering contributing to Jean Memory! It's people like you that make the open source community such a great place. We welcome contributions of all kinds, from bug fixes and documentation improvements to new features and context engineering workflows.
We want to make it as easy as possible to contribute to Jean Memory. Here are a few ways you can help:
- Reporting Bugs: If you find a bug, please open an issue and provide as much detail as possible.
- Suggesting Enhancements: If you have an idea for a new feature or an improvement to an existing one, please open an issue to discuss it.
- Pull Requests: If you're ready to contribute code, we'd love to see your pull requests.
We are particularly interested in contributions that expand the capabilities of Jean Memory. Here are a few areas where you can make a big impact:
- Context Engineering Workflows: We believe that the true power of Jean Memory lies in its flexibility. We encourage you to create your own context engineering workflows that are tailored to specific use cases. If you create a workflow that you think would be useful to others, please open a pull request to add it to our collection of examples.
- New Use Cases: We're always looking for new and interesting ways to use Jean Memory. If you've built an application that uses Jean Memory in a novel way, we'd love to hear about it. Please open an issue to share your use case with the community.
- Personalized Software Applications: We're excited to see how developers use Jean Memory to create personalized software applications. If you've built an application that uses Jean Memory to onboard users and get their context into the platform, we'd love to see it. Please open an issue to share your application with the community.
If you're new to the project, here are a few resources to help you get started:
- README.md: The main README file for the project.
- Local Development Setup: Instructions for setting up a local development environment.
- API Documentation: Detailed documentation for the Jean Memory API.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at jonathan@jeantechnologies.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4/