-
Notifications
You must be signed in to change notification settings - Fork 112
docs: add CONTRIBUTING.md #197
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sidhansu10
wants to merge
2
commits into
AOSSIE-Org:main
Choose a base branch
from
sidhansu10:docs/add-contributing-md
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| # Contributing to Devr.AI | ||
| Thank you for your interest in contributing to **Devr.AI** | ||
| We welcome contributions from developers of all experience levels and appreciate your time and effort. | ||
|
|
||
| This document provides guidelines to help you contribute effectively and collaborate smoothly with the community. | ||
|
|
||
|
|
||
| ## Code of Conduct | ||
| Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md). | ||
| We are committed to maintaining a respectful, inclusive, and harassment-free environment for everyone. | ||
|
|
||
|
|
||
| ## How You Can Contribute | ||
| You can contribute to Devr.AI in many ways, including but not limited to: | ||
| 1. Reporting bugs | ||
| 2. Suggesting new features or improvements | ||
| 3. Improving documentation | ||
| 4. Fixing existing issues | ||
| 5. Reviewing pull requests | ||
|
|
||
| Before starting work, please check the **Issues** tab and look for: | ||
| - `good first issue` | ||
| - `bug` | ||
| - `enhancement` | ||
|
|
||
| If you plan to work on an issue, leave a comment to let others know. | ||
|
|
||
|
|
||
| ## Getting Started | ||
| ### 1. Fork the Repository | ||
| Click the **Fork** button on GitHub to create your own copy of the repository. | ||
|
|
||
| ### 2. Clone Your Fork | ||
| ```bash | ||
| git clone https://github.com/<your-username>/Devr.AI.git | ||
| cd Devr.AI | ||
| ``` | ||
|
|
||
|
|
||
| ## Development Setup | ||
| Devr.AI uses a multi-service architecture involving AI agents, message queues, and multiple databases. | ||
|
|
||
| Please follow the official setup instructions here: | ||
| - [Installation Guide](./docs/INSTALL_GUIDE.md) | ||
|
|
||
| This guide covers environment variables, database setup, and running the backend and frontend locally. | ||
|
|
||
|
|
||
| ## Branch Naming Convention | ||
| Create a new branch for every change. | ||
|
|
||
| Recommended formats: | ||
| - `feat/short-description` | ||
| - `fix/issue-description` | ||
| - `docs/update-documentation` | ||
| - `chore/cleanup-task` | ||
|
|
||
| Example: | ||
| ```bash | ||
| git checkout -b docs/add-contributing-md | ||
| ``` | ||
|
|
||
|
|
||
| ## Pull Request Guidelines | ||
| Before submitting a PR: | ||
| 1. Keep changes small and focused | ||
| 2. Update your branch with main | ||
| 3. Clearly explain what, why, and how | ||
| 4. Link issues using Closes #issue-number | ||
|
|
||
| After submitting: | ||
| 1. Respond to review comments politely | ||
| 2. Make requested changes in the same PR | ||
|
|
||
|
|
||
| ## Getting Help | ||
| If you need help: | ||
| 1. Join our Discord | ||
| 2. Use GitHub Discussions | ||
| 3. Ask in the issue you are working on | ||
|
|
||
| Thank you for contributing to Devr.AI! | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.