Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (41 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

63 lines (41 loc) · 2.47 KB
Raw

Contributing to Rusoil Software

Thank you for your interest in contributing! Rusoil Software is a nt-run study group and collaborative GitHub organization. All contributions are for educational and study purposes only. By contributing you agree to follow these guidelines so we keep the community welcoming and productive.

Our purpose

  • We exist to learn, teach, and practice software development across faculties and study groups.
  • This organization is non-commercial — no for-profit activity or donations are accepted unless explicitly approved and documented by the community.

How to contribute

  1. Read the repository README.md and LICENSE.
  2. Check open issues and PRs for related work before starting.
  3. If you’re unsure, open an issue or ask in the project’s communication channel.

Workflow

  • Fork the repository (if not a direct collaborator).
  • Create a branch with a descriptive name: feat/short-desc, fix/short-desc, docs/short-desc.
  • Keep changes small and focused.
  • Write tests where applicable and update documentation.
  • Open a Pull Request describing what you changed and why.

Branch & commit conventions

  • Branch prefixes: feat/, fix/, chore/, docs/, refactor/.
  • Commit message style: type(scope): short description (e.g., feat(api): add user search).
  • Sign commits if the repository requires DCO.

Pull request checklist

  • I have read the contributing guidelines and repository README.
  • My code follows the language/style guidelines for the project.
  • I have added or updated tests where applicable.
  • Documentation updated (README, docs/, examples).
  • CI is passing.

Code quality & testing

  • Prefer readability over cleverness.
  • Follow the language-specific style guide used by the repo.
  • Add tests for new logic and ensure existing tests pass.
  • Use the project’s CI to run tests and linters.

Communication & reviews

  • Be respectful and constructive in code reviews.
  • Explain why changes are needed and suggest concrete improvements.
  • Maintainers have final merge rights for their repositories.

Licensing contributions

By submitting a pull request you agree your contributions will be made available under the repository’s license.

Accessibility & inclusivity

  • Try to make documentation and examples accessible to newcomers.
  • Avoid jargon; explain domain-specific terms when they appear.

Questions

If you need help, contact the repository maintainers or the organization Team Lead.