Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (31 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 1.79 KB

Contribution Guidelines

This repo is a one-size fits all for any material that is made withing CS foreach using the p5 curriculum.

Contributors

[!Caution] TBD

Contributing

All contributors are invited to submit issues for the following:

  • Bugs
  • Feature Requests
  • Discussion

Contributing to issues

[!Caution] TBD

Contributing pull requests

When contributing to the repo, please insure that:

  • The PR resolves at least one existing/documented issue
    • Include issue number by linking the #XXX in the description
  • Write small PRs that handle specific topics
  • Format commit messages with readability in mind
    • Start with an action verb like "Fix" or "Add"

Git Branching Strategy

We incorporate a modified GitHub flow branching strategy.

Each feature has an overarching branch that is prefixed with <issue number>-feature-<feature_name> which then has subsequent branches implementing parts of that feature. The intention is to make small PRs that are easier to conduct code review for. See the attached image example for more details.

Branching Strategy Branching Strategy

FAQ

If you have any questions or concerns, contact ryan@codewithher.org.

  • Not familar with git/version control?
  • Not familiar with markdown?
    • Make sure you use the "preview" feature instead of spamming commits
    • Do a quick scan of Markdownguide
    • Look at the code view of existing issues or PRs