Skip to content

An AI-powered search engine with a generative UI

docs: add contribution guidelines and code of conduct

Yoshiki Miura674112992f7b
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 00000000..cc13406e
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,64 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+ overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+ advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+ address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+[homepage]: https://www.contributor-covenant.org
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..c70c87a7
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,48 @@
+# Contributing to Morphic
+
+Thank you for your interest in contributing to Morphic! This document provides guidelines and instructions for contributing.
+
+## Code of Conduct
+
+By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## How to Contribute
+
+### Reporting Issues
+
+- Check if the issue already exists in our [GitHub Issues](https://github.com/miurla/morphic/issues)
+- Use the issue templates when creating a new issue
+- Provide as much context as possible
+
+### Pull Requests
+
+1. Fork the repository
+2. Create a new branch from `main`:
+ ```bash
+ git checkout -b feat/your-feature-name
+ ```
+3. Make your changes
+4. Commit your changes using conventional commits:
+ ```bash
+ git commit -m "feat: add new feature"
+ ```
+5. Push to your fork
+6. Open a Pull Request
+
+### Commit Convention
+
+We use conventional commits. Examples:
+
+- `feat: add new feature`
+- `fix: resolve issue with X`
+- `docs: update README`
+- `chore: update dependencies`
+- `refactor: improve code structure`
+
+### Development Setup
+
+Follow the [Quickstart](README.md#-quickstart) guide in the README to set up your development environment.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.
diff --git a/README.md b/README.md
index 0a0aa051..a4f60fe2 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,7 @@ An AI-powered search engine with a generative UI.
- ✅ [Verified models](#-verified-models)
- ⚡ [AI SDK Implementation](#-ai-sdk-implementation)
- 📦 [Open Source vs Cloud Offering](#-open-source-vs-cloud-offering)
+- 👥 [Contributing](#-contributing)
## 🛠 Features
@@ -201,3 +202,14 @@ Morphic is open source software available under the Apache-2.0 license.
To maintain sustainable development and provide cloud-ready features, we offer a hosted version of Morphic alongside our open-source offering. The cloud solution makes Morphic accessible to non-technical users and provides additional features while keeping the core functionality open and available for developers.
For our cloud service, visit [morphic.sh](https://morphic.sh).
+
+## 👥 Contributing
+
+We welcome contributions to Morphic! Whether it's bug reports, feature requests, or pull requests, all contributions are appreciated.
+
+Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
+
+- How to submit issues
+- How to submit pull requests
+- Commit message conventions
+- Development setup