docs: add contributor onboarding guide#144
Merged
ved015 merged 4 commits intoXortexAI:mainfrom May 5, 2026
Merged
Conversation
ishaanxgupta
reviewed
May 2, 2026
| Install the project with development dependencies: | ||
|
|
||
| ```bash | ||
| pip install -e ".[dev]" |
Member
There was a problem hiding this comment.
pip install -e . is enough I think
ishaanxgupta
reviewed
May 2, 2026
|
|
||
| If you need the full local stack, use the Docker Compose files in `docker/`. | ||
|
|
||
| ## Testing |
Member
There was a problem hiding this comment.
lets leave this for now as we dont have a proper test suite
ishaanxgupta
reviewed
May 2, 2026
| - ... | ||
| ``` | ||
|
|
||
| ## Review Process |
Member
There was a problem hiding this comment.
We can remove this section for now
Member
|
Rest Looks good to me |
Contributor
|
@Ankit-Kotnala pls make these changes so that we can add this to the merge queue |
Removed sections on creating environment files, running locally, testing, and review process from CONTRIBUTING.md.
ved015
requested changes
May 5, 2026
Contributor
There was a problem hiding this comment.
pls resolve the suggestion which @ishaanxgupta raised then we can merge this😁
Done with the modifications suggested by the maintainer.
Contributor
|
Thank you @Ankit-Kotnala for the contribution |
Contributor
Author
|
Thank you @ved015 and @ishaanxgupta for being so spontaneous. Would catch you guys in another issue prolly. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
@ishaanxgupta please review this.
Summary
CONTRIBUTING.mdas the centralized onboarding guide for new contributors.Notes