Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (35 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 1.19 KB
Raw

Contributing

Thanks for your interest in contributing! Follow these steps to get started.

1. Fork the repository

Click the Fork button at the top right of this page to create your own copy of the repo.

2. Clone your fork

git clone https://github.com/zt4ff/01-edu-audit-scripts.git
cd 01-edu-audit-scripts

3. Create a branch

Use a short, descriptive name for your branch:

git checkout -b add-quad-checker-script

4. Make your changes

Edit the files you want to change. Keep your changes focused. One script or feature per pull request.

5. Commit your changes

git add .
git commit -m "Brief description of what you changed"

6. Push to your fork

git push origin add-quad-checker-script

7. Open a Pull Request

  1. Go to your fork on GitHub
  2. Click Compare & pull request
  3. Write a short description of what you changed and why
  4. Click Create pull request

Guidelines

  • Keep pull requests small and focused
  • Write clear commit messages
  • If you're fixing a bug or adding a feature, mention the related issue (e.g. Closes #12)
  • Be respectful, we follow the Contributor Covenant