Skip to content

docs: Add comprehensive CONTRIBUTING.md guide#1

Merged
AlexGromer merged 1 commit into
mainfrom
feature/add-contributing-guide
Jan 25, 2026
Merged

docs: Add comprehensive CONTRIBUTING.md guide#1
AlexGromer merged 1 commit into
mainfrom
feature/add-contributing-guide

Conversation

@AlexGromer
Copy link
Copy Markdown
Owner

Summary

Added comprehensive contribution guidelines in both English and Russian to help new contributors get started with the project.

Changes

  • ✅ Added CONTRIBUTING.md with bilingual documentation
  • ✅ Development setup instructions
  • ✅ Testing guidelines with examples (Bash + Go)
  • ✅ Pull Request process and commit message format
  • ✅ Coding standards (following Google Shell Style Guide + Effective Go)
  • ✅ Security guidelines
  • ✅ Pre-submission checklist

Why This Matters

This will help potential contributors:

  • Understand how to set up their development environment
  • Write tests that match the project's standards
  • Follow the established commit message format
  • Understand security requirements
  • Navigate the PR process smoothly

Test Plan

  • Documentation reviewed
  • Both English and Russian sections complete
  • Examples tested and verified
  • Links to project files validated

Related

Part of initial repository setup to ensure a welcoming and well-documented contribution process.


🤖 Generated with Claude Code

- Added comprehensive contribution guidelines
- Bilingual documentation (English + Russian)
- Development setup instructions
- Testing guidelines
- PR process and coding standards
- Security guidelines

This will help new contributors get started quickly.
@AlexGromer AlexGromer merged commit 241641d into main Jan 25, 2026
4 of 6 checks passed
@github-advanced-security
Copy link
Copy Markdown

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants