Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.09 KB

File metadata and controls

62 lines (41 loc) · 2.09 KB

Contributing to CODE CREW NEXUS

Thanks for contributing to CODE CREW NEXUS.

This organization is used for academic work, subject-based repositories, project collaboration, and structured experimentation. Since many repositories may be used by students working in teams, we want contributions to stay clear, respectful, and easy to review.

Before You Start

  • Read the repository README.md before making changes.
  • Understand the repository structure and naming style.
  • Check existing issues, tasks, or project notes before starting duplicate work.
  • If the change is large, discuss it with the maintainers or repository team first.

Contribution Expectations

  • Keep code readable and logically organized.
  • Add or update documentation when needed.
  • Use meaningful commit messages.
  • Avoid unrelated changes in the same pull request.
  • Respect project-specific requirements if a repository has extra rules.

Pull Request Guidelines

Before opening a pull request:

  • Make sure your branch is up to date with the target branch.
  • Verify that your changes are relevant to the repository.
  • Test your changes where applicable.
  • Update docs, screenshots, diagrams, or notes if the work affects them.

Your pull request should clearly mention:

  • what was changed,
  • why the change was needed,
  • and any assumptions or follow-up work.

Documentation Standards

For student and academic repositories, documentation matters as much as implementation.

When relevant, include:

  • problem statement or project objective,
  • setup and usage steps,
  • diagrams or workflow notes,
  • subject context,
  • and explanation of implementation logic.

Collaboration Standards

  • Be respectful in discussions and reviews.
  • Give constructive and specific feedback.
  • Do not remove or overwrite someone else's work without discussion.
  • Ask when unsure instead of guessing on important changes.

Maintainer Note

Repository maintainers may request changes before merge to preserve consistency, readability, or academic/project quality.

Quick Reminder

Always read the repository README.md once before opening a pull request.