Skip to content

Commit 65b57bc

Browse files
authored
Create CONTRIBUTING.md
Signed-off-by: Adithya S K <adithyaskolavi@gmail.com>
1 parent 5452e3e commit 65b57bc

File tree

1 file changed

+101
-0
lines changed

1 file changed

+101
-0
lines changed

CONTRIBUTING.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Contributing to RAG-SaaS
2+
3+
First off, thank you for considering contributing to RAG-SaaS! It's people like you that make RAG-SaaS such a great tool. We welcome contributions from everyone, whether it's a bug report, feature request, documentation improvement, or a code contribution.
4+
5+
## Table of Contents
6+
7+
1. [Code of Conduct](#code-of-conduct)
8+
2. [Getting Started](#getting-started)
9+
3. [How Can I Contribute?](#how-can-i-contribute)
10+
- [Reporting Bugs](#reporting-bugs)
11+
- [Suggesting Enhancements](#suggesting-enhancements)
12+
- [Your First Code Contribution](#your-first-code-contribution)
13+
- [Pull Requests](#pull-requests)
14+
4. [Style Guidelines](#style-guidelines)
15+
- [Git Commit Messages](#git-commit-messages)
16+
- [Python Style Guide](#python-style-guide)
17+
- [JavaScript Style Guide](#javascript-style-guide)
18+
5. [Additional Notes](#additional-notes)
19+
20+
## Code of Conduct
21+
22+
This project and everyone participating in it is governed by the [RAG-SaaS Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [adithyaskolavi@gmail.com](mailto:adithyaskolavi@gmail.com).
23+
24+
## Getting Started
25+
26+
1. Fork the repository on GitHub
27+
2. Clone your fork locally
28+
3. Set up your environment (see README.md for details)
29+
4. Create a branch for your changes
30+
5. Make your changes
31+
6. Run tests and ensure they pass
32+
7. Commit your changes
33+
8. Push your changes to your fork
34+
9. Open a pull request
35+
36+
## How Can I Contribute?
37+
38+
### Reporting Bugs
39+
40+
- Before submitting a bug report, please check the existing issues to see if someone has already reported the problem.
41+
- When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
42+
43+
### Suggesting Enhancements
44+
45+
- Before creating enhancement suggestions, please check the existing issues to see if the enhancement has already been suggested.
46+
- When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
47+
48+
### Your First Code Contribution
49+
50+
Unsure where to begin contributing to RAG-SaaS? You can start by looking through these `beginner` and `help-wanted` issues:
51+
52+
- [Beginner issues](https://github.com/adithya-s-k/RAG-SaaS/labels/beginner) - issues which should only require a few lines of code, and a test or two.
53+
- [Help wanted issues](https://github.com/adithya-s-k/RAG-SaaS/labels/help%20wanted) - issues which should be a bit more involved than `beginner` issues.
54+
55+
### Pull Requests
56+
57+
- Fill in the required template
58+
- Do not include issue numbers in the PR title
59+
- Include screenshots and animated GIFs in your pull request whenever possible
60+
- Follow the [Python](#python-style-guide) and [JavaScript](#javascript-style-guide) style guides
61+
- Document new code based on the Documentation Style Guide
62+
- End all files with a newline
63+
64+
## Style Guidelines
65+
66+
### Git Commit Messages
67+
68+
- Use the present tense ("Add feature" not "Added feature")
69+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
70+
- Limit the first line to 72 characters or less
71+
- Reference issues and pull requests liberally after the first line
72+
73+
### Python Style Guide
74+
75+
- Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/)
76+
- Use 4 spaces for indentation (not tabs)
77+
- Use docstrings for functions and classes
78+
- Use type hints where possible
79+
80+
### JavaScript Style Guide
81+
82+
- Use 2 spaces for indentation (not tabs)
83+
- Use semicolons at the end of each statement
84+
- Use single quotes for strings
85+
- Use camelCase for variable and function names
86+
- Use PascalCase for class names
87+
88+
## Additional Notes
89+
90+
### Issue and Pull Request Labels
91+
92+
This section lists the labels we use to help us track and manage issues and pull requests.
93+
94+
- `bug` - Issues for bugs in the code
95+
- `enhancement` - Issues for new features or improvements
96+
- `documentation` - Issues related to documentation
97+
- `good first issue` - Good for newcomers
98+
- `help wanted` - Extra attention is needed
99+
- `question` - Further information is requested
100+
101+
Thank you for contributing to RAG-SaaS!

0 commit comments

Comments
 (0)