docs: add comprehensive contribution guidelines and developer documentation#450
Open
giwaov wants to merge 1 commit intogenlayer-foundation:devfrom
Open
docs: add comprehensive contribution guidelines and developer documentation#450giwaov wants to merge 1 commit intogenlayer-foundation:devfrom
giwaov wants to merge 1 commit intogenlayer-foundation:devfrom
Conversation
…tation Add CONTRIBUTING.md with detailed contribution workflow: - Development setup instructions for backend and frontend - Branch naming conventions (target dev branch) - Pull request guidelines and commit message format - Coding standards for Python and Svelte 5 - Testing guidelines and security considerations Add SECURITY.md for security policies: - Vulnerability reporting process - Authentication and API security best practices - Development security guidelines - Security checklist for contributors Add developer documentation: - docs/API_REFERENCE.md with complete API endpoint documentation - docs/BEST_PRACTICES.md with Django and Svelte 5 patterns Add backend improvements: - Nonce cleanup management command (cleanup_nonces) - Prevents database bloat from expired authentication nonces Fix frontend API: - Add submissionsAPI for user submission management - Provides getMySubmissions, createSubmission, updateSubmission, etc. Fix README.md: - Update repository URL from placeholder - Add environment variable configuration steps - Reference CONTRIBUTING.md and SECURITY.md
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
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.
Summary
This PR adds comprehensive contribution guidelines and developer documentation to improve the developer experience for new and existing contributors.
Changes
New Files
CONTRIBUTING.md - Complete contribution workflow guide
devas target branch)SECURITY.md - Security policy document
docs/API_REFERENCE.md - Complete API endpoint documentation
docs/BEST_PRACTICES.md - Developer best practices guide
Backend Improvements
backend/ethereum_auth/management/commands/cleanup_nonces.py)Frontend Improvements
frontend/src/lib/api.jsgetMySubmissions(params)- Get current user's submissionsgetSubmission(id)- Get single submissioncreateSubmission(data)- Create new submissionupdateSubmission(id, data)- Update existing submissioncancelSubmission(id)- Cancel/soft-delete submissionaddEvidence(id, data)- Add evidence to submissionDocumentation Fixes
yourusername→genlayer-foundation)bashsyntax highlightingWhy These Changes?
Testing
--dry-runflagRelated Issues
Addresses general developer experience improvements and helps with contribution guidelines commonly requested by new contributors.