Skip to content

Commit 6741129

Browse files
miurlamiurla
committed
docs: add contribution guidelines and code of conduct
1 parent 7e6909c commit 6741129

File tree

3 files changed

+124
-0
lines changed

3 files changed

+124
-0
lines changed

‎CODE_OF_CONDUCT.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all community spaces, and also applies when
49+
an individual is officially representing the community in public spaces.
50+
51+
## Enforcement
52+
53+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
54+
reported to the community leaders responsible for enforcement at
55+
[INSERT CONTACT METHOD].
56+
All complaints will be reviewed and investigated promptly and fairly.
57+
58+
## Attribution
59+
60+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
61+
version 2.0, available at
62+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
63+
64+
[homepage]: https://www.contributor-covenant.org

‎CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing to Morphic
2+
3+
Thank you for your interest in contributing to Morphic! This document provides guidelines and instructions for contributing.
4+
5+
## Code of Conduct
6+
7+
By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
8+
9+
## How to Contribute
10+
11+
### Reporting Issues
12+
13+
- Check if the issue already exists in our [GitHub Issues](https://github.com/miurla/morphic/issues)
14+
- Use the issue templates when creating a new issue
15+
- Provide as much context as possible
16+
17+
### Pull Requests
18+
19+
1. Fork the repository
20+
2. Create a new branch from `main`:
21+
```bash
22+
git checkout -b feat/your-feature-name
23+
```
24+
3. Make your changes
25+
4. Commit your changes using conventional commits:
26+
```bash
27+
git commit -m "feat: add new feature"
28+
```
29+
5. Push to your fork
30+
6. Open a Pull Request
31+
32+
### Commit Convention
33+
34+
We use conventional commits. Examples:
35+
36+
- `feat: add new feature`
37+
- `fix: resolve issue with X`
38+
- `docs: update README`
39+
- `chore: update dependencies`
40+
- `refactor: improve code structure`
41+
42+
### Development Setup
43+
44+
Follow the [Quickstart](README.md#-quickstart) guide in the README to set up your development environment.
45+
46+
## License
47+
48+
By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.

‎README.md

+12
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ An AI-powered search engine with a generative UI.
1414
- ✅ [Verified models](#-verified-models)
1515
- ⚡ [AI SDK Implementation](#-ai-sdk-implementation)
1616
- 📦 [Open Source vs Cloud Offering](#-open-source-vs-cloud-offering)
17+
- 👥 [Contributing](#-contributing)
1718

1819
## 🛠 Features
1920

@@ -201,3 +202,14 @@ Morphic is open source software available under the Apache-2.0 license.
201202
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.
202203

203204
For our cloud service, visit [morphic.sh](https://morphic.sh).
205+
206+
## 👥 Contributing
207+
208+
We welcome contributions to Morphic! Whether it's bug reports, feature requests, or pull requests, all contributions are appreciated.
209+
210+
Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
211+
212+
- How to submit issues
213+
- How to submit pull requests
214+
- Commit message conventions
215+
- Development setup

0 commit comments

Comments
 (0)