Contributing Guidelines

This document provides brief guidance for contributing to and maintaining RSG repositories.
For more details and best practices, see:
Using GitHub at RSG

General Principles

• Keep repositories private unless there is a reason to make them public.
• Make sure your repository has a clear README explaining its purpose and usage.
• Use clear, descriptive commit messages.
• Keep your code and documentation up to date.
• Delete unused branches regularly.

Collaborating

• Add or remove collaborators as needed using repository settings. Add collaborators as part of a team rather than individually whenever possible.
• Assign repository admin rights sparingly—most users only need "write" access.
• If you need to transfer ownership or archive a repo, follow organization procedures.

Issues and Pull Requests

• Avoid committing directly to the main branch. It is recommended to use branches and pull requests for changes.
• Use issues for tracking bugs and discussions.
• If using issues, associate them with pull requests and close them when resolved. Use labels if helpful for tracking.

Sensitive Information

• Never commit passwords, API keys, or sensitive data to the repository.
• If you accidentally commit sensitive information, remove it and contact an admin.

Archiving and Cleanup

• Archive repositories that are no longer actively maintained.
• Remove obsolete files and documentation to keep the repo tidy.

More Information

For detailed guidance, refer to the full documentation:
Using GitHub at RSG