Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.88 KB

File metadata and controls

37 lines (26 loc) · 1.88 KB

Guidelines

We appreciate all contributions to R-Type. To maintain a cohesive codebase and streamline the contribution process, please adhere to the following guidelines:

No. Titre
1. Pull requests
2. Issues
3. Code Style and Standards
4. Communication

Pull requests

  • Ensure your pull request addresses a specific issue or purpose. If none exists, consider creating one to discuss changes with the maintainers.
  • Create descriptive commit messages that summarize the changes made.
  • Keep pull requests focused on a single feature/fix. Larger changes should be broken down into smaller, manageable parts.
  • Test your changes thoroughly to avoid breaking existing functionality.
  • Provide accompanying documentation or update the existing documentation as needed.
  • Be responsive to feedback and iterate on your pull request based on code review comments.

Issues

  • Before opening a new issue, search existing ones to prevent duplicates.
  • Clearly describe the problem or feature request in the issue, providing as much context as possible.
  • Use labels appropriately to categorize the issue (e.g., bug, enhancement, help wanted).

Code Style and Standards

  • Follow the established code style and formatting conventions used in the project.
  • Write clean, readable, and self-explanatory code.
  • Comment code when necessary to clarify complex logic or functionality.

Communication

  • Discuss significant changes or new features by opening an issue first to communicate with the maintainers and gather feedback.
  • Be respectful and considerate when interacting with other contributors or maintainers.