Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (50 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

75 lines (50 loc) · 1.89 KB
Raw

Contributing

Thank You

Thank you for your interest in contributing to C Project Template! This guide will help you get started.

Links

Requirements

  • A GitHub account
  • Git installed on your local machine
  • A C compiler (e.g. gcc)
  • A text editor or IDE

Getting Started

  1. Sign up for GitHub if you don't have an account.
  2. Fork the repository by clicking Fork at the top right of the repo page.
  3. Clone your fork: git clone https://github.com/<your-username>/c-project-template.git
  4. Open the project in your editor or IDE.
  5. Compile the project: gcc projectTemplate.c -o projectTemplate.exe If you encounter errors, please open an issue.

Identifying What to Work On

Issues

Work items are tracked as GitHub issues.

Milestones

Issues are grouped into milestones representing upcoming releases.

Making Changes

  1. Make sure an issue exists for the work. If not, create one.
  2. Switch to develop: git checkout develop
  3. Create a branch: git checkout -b <branch-name>
  4. Make your changes.
  5. Test your changes.
  6. Commit: git commit -m "Description of changes"
  7. Push: git push origin <branch-name>
  8. Open a pull request against develop, link the related issue with #<number>.
  9. Address review feedback.

Testing

Compile and run the project to verify your changes:

Linux / macOS:

gcc projectTemplate.c -o projectTemplate.exe
./projectTemplate.exe

Windows (with MinGW or similar):

gcc projectTemplate.c -o projectTemplate.exe
projectTemplate.exe

You can also use the provided compile-and-run script:

./cr.sh

Questions

Open a GitHub Discussion or issue in this repository.