Skip to content

Commit 79a3799

Browse files
committed
chore: add LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md
1 parent 4190f0a commit 79a3799

3 files changed

Lines changed: 156 additions & 1 deletion

File tree

CODE_OF_CONDUCT.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributor Covenant 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+
## Our Standards
13+
14+
Examples of behavior that contributes to a positive environment:
15+
16+
* Using welcoming and inclusive language
17+
* Being respectful of differing viewpoints and experiences
18+
* Gracefully accepting constructive criticism
19+
* Focusing on what is best for the community
20+
* Showing empathy towards other community members
21+
22+
Examples of unacceptable behavior:
23+
24+
* The use of sexualized language or imagery and unwelcome sexual attention
25+
* Trolling, insulting/derogatory comments, and personal or political attacks
26+
* Public or private harassment
27+
* Publishing others' private information without explicit permission
28+
* Other conduct which could reasonably be considered inappropriate
29+
30+
## Enforcement Responsibilities
31+
32+
Community leaders are responsible for clarifying and enforcing our standards of
33+
acceptable behavior and will take appropriate and fair corrective action in
34+
response to any behavior that they deem inappropriate, threatening, offensive,
35+
or harmful.
36+
37+
## Scope
38+
39+
This Code of Conduct applies within all community spaces, and also applies when
40+
an individual is officially representing the community in public spaces.
41+
42+
## Enforcement
43+
44+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
45+
reported to the community leaders responsible for enforcement at
46+
conduct@gitant.io.
47+
48+
## Attribution
49+
50+
This Code of Conduct is adapted from the Contributor Covenant, version 2.0,
51+
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

CONTRIBUTING.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Contributing to Gitant
2+
3+
Thank you for your interest in contributing to Gitant! This document provides guidelines and instructions for contributing.
4+
5+
## Getting Started
6+
7+
1. Fork the repository
8+
2. Clone your fork
9+
3. Create a feature branch
10+
4. Make your changes
11+
5. Submit a pull request
12+
13+
## Development Setup
14+
15+
### Prerequisites
16+
17+
- Go 1.26+
18+
- Node.js 20+
19+
- Git
20+
21+
### Daemon
22+
23+
```bash
24+
cd gitant-daemon
25+
make build
26+
make test
27+
make lint
28+
```
29+
30+
### CLI
31+
32+
```bash
33+
cd gitant-cli
34+
make build
35+
make test
36+
```
37+
38+
### MCP Server
39+
40+
```bash
41+
cd gitant-mcp
42+
npm install
43+
npm run build
44+
npm test
45+
```
46+
47+
### Web UI
48+
49+
```bash
50+
cd gitant-web
51+
npm install
52+
npm run dev
53+
```
54+
55+
## Code Style
56+
57+
### Go
58+
59+
- Follow standard Go conventions
60+
- Run `gofmt` before committing
61+
- Run `golangci-lint` for linting
62+
- Write tests for new features
63+
64+
### TypeScript
65+
66+
- Use ESLint with the provided config
67+
- Run `npm run lint` before committing
68+
- Write tests for new features
69+
70+
## Commit Messages
71+
72+
Follow conventional commits:
73+
74+
```
75+
feat: add new feature
76+
fix: fix bug
77+
docs: update documentation
78+
test: add tests
79+
refactor: refactor code
80+
chore: update dependencies
81+
```
82+
83+
## Pull Request Process
84+
85+
1. Update documentation if needed
86+
2. Add tests for new features
87+
3. Ensure all tests pass
88+
4. Ensure lint passes
89+
5. Request review from maintainers
90+
91+
## Reporting Issues
92+
93+
- Use GitHub Issues
94+
- Include reproduction steps
95+
- Include system information
96+
- Include logs if applicable
97+
98+
## Code of Conduct
99+
100+
Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
101+
102+
## License
103+
104+
By contributing, you agree that your contributions will be licensed under the MIT License.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2026 Lakshman Patel
3+
Copyright (c) 2026 Gitant Contributors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)