Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
108 lines (81 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

108 lines (81 loc) · 3.72 KB
Raw

Contributing to Brabus Stories

Thank you for your interest in contributing to the Brabus Stories collection! While these are personal creative works, community contributions are welcome in specific areas.

How You Can Contribute

📝 Corrections & Improvements

  • Typos and grammar fixes in both English and Russian versions
  • Formatting improvements for better readability
  • Translation refinements to improve accuracy between language versions
  • Metadata corrections in story headers

🌍 Translations

  • New language translations of existing stories (with author approval)
  • Quality improvements to existing Russian translations
  • Cultural adaptation notes where appropriate

🛠️ Technical Improvements

  • README enhancements and documentation
  • Build scripts for generating EPUB/PDF versions
  • GitHub Pages setup for better reading experience
  • Accessibility improvements

💡 Suggestions

  • Reader experience improvements
  • Navigation enhancements
  • Metadata structure suggestions

What We Don't Accept

  • New stories (this is a personal creative collection)
  • Major plot or character changes to existing stories
  • Style changes that alter the author's voice
  • Commercial use suggestions (handle separately via licensing)

How to Contribute

For Small Fixes (Typos, Grammar)

  1. Fork the repository
  2. Create a branch: git checkout -b fix/typo-in-echo
  3. Make your changes with clear, minimal edits
  4. Test that links and formatting still work
  5. Submit a Pull Request with descriptive title

For Larger Changes (Translations, Features)

  1. Open an Issue first to discuss the proposed changes
  2. Wait for approval before starting significant work
  3. Follow the same PR process once approved

Style Guidelines

For Text Corrections

  • Preserve the author's voice and style choices
  • Minimal changes - fix errors, don't rewrite
  • Maintain consistency between English and Russian versions
  • Keep the same tone and mood

For Technical Contributions

  • Follow existing patterns in file structure and naming
  • Test thoroughly before submitting
  • Document changes clearly in PR description
  • Maintain cross-platform compatibility

File Structure Rules

When making changes, maintain:

  • Consistent naming: story_name.en.md and story_name.ru.md pattern (if restructuring)
  • Header metadata: Keep the comment headers in all files
  • Link integrity: Ensure all README links still work
  • Bilingual parity: Changes to one language should consider the other

Review Process

  1. All PRs are reviewed by the author (Brabus)
  2. Small fixes are typically merged quickly
  3. Larger changes may require discussion and iteration
  4. Translation PRs may need native speaker review

Recognition

Contributors will be acknowledged in:

  • README contributors section (for significant contributions)
  • Git commit history (for all contributions)
  • Release notes (for version-impacting changes)

Questions?

License Note

By contributing, you agree that your contributions will be licensed under the same Creative Commons BY-NC-SA 4.0 license as the project.

Author: Brabus | Company: EasyProTech LLC
Contact: https://t.me/easyprotech | Website: www.easypro.tech