Skip to content

Commit 4c86dde

Browse files
authored
Create CONTRIBUTING.md
1 parent 1f10ff8 commit 4c86dde

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing to gitconvex
2+
3+
Gitconvex is powered by React JS for the front-end and Golang for the back-end. As the tech stack is different, the project has been split into two public repositories for ease of maintenance.
4+
5+
- **Frontend repo (React JS)**
6+
7+
[![gitconvex-ui](https://github-readme-stats-git-master.neel1996.vercel.app/api/pin/?username=neel1996&repo=gitconvex-ui)](https://github.com/neel1996/gitconvex-ui)
8+
9+
- **Backend repo (Golang)**
10+
11+
[![gitconvex-server](https://github-readme-stats-git-master.neel1996.vercel.app/api/pin/?username=neel1996&repo=gitconvex-server)](https://github.com/neel1996/gitconvex-server)
12+
13+
14+
# Guidelines
15+
16+
This repository is a bundle with both the UI and server source code, so the contributions will not be directly accepted here. If you are interested in contributing to the project, then please make it towards the [gitconvex-ui](https://github.com/neel1996/gitconvex-ui) or [gitconvex-server](https://github.com/neel1996/gitconvex-server)
17+
18+
## Branching
19+
20+
Both the UI and server repos have their own `development` branch which will stay open for contributions. Fork the repo and raise a new pull request from your forked repo to the `development` branch of the actual repo. The PR will be reviewed by the maintainers and it will be merged to the `main` branch.
21+
22+
# Help and Feedback
23+
24+
For reporting issues or for requesting new features, use the following channels
25+
26+
[**Discord Channel** ](https://discord.gg/PSd2Cq9)
27+
28+
[**Github Issues**](https://github.com/neel1996/gitconvex/issues)
29+
30+
![open issues](https://img.shields.io/github/issues/neel1996/gitconvex?color=orange&style=for-the-badge)

0 commit comments

Comments
 (0)