Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 2.39 KB
Raw

Contributing to NumGeomWorks Code Suite

Welcome, NumGeomers! We're glad that you are reading this and want to help improve NumGeomWorks Code Suite.

Styleguides

Git commit messages

  • Commit messages should start with verbs and be consistent with past and present tenses (e.g., either "Fix a bug" or "Fixed a bug" is fine, but not "I fixed a bug")
  • Try to be comprehensive regarding the message: Use a brief introduction with a more detailed description, see below
$ git commit -m "Fixed a bug regarding blah...
>
> more detailed information goes here"
  • For minor changes, it is okay to commit your changes with a single-line message

Coding styles

As a NumGeomer, you should have read our guidelines regarding code development; see the General channel in Teams, and read Developer's Guide and MATLAB Coder carefully. Make sure your code development follows those guidelines.

Issue and Pull Requests (PRs)

New students?

You may be assigned to specific task items if you are a new student. We will be grateful if you can address those task items by making PRs. While making a PR, it will automatically set up a template for you, so follow the PR templates, and everything should be ready to go!

Experienced members?

If you want to fix some bugs or add some features, please do so via PRs. If you don't have time to or cannot do it yourself, please submit an issue. Note that while submitting issues, you can use our issue template to ease the process and help us keep everything tracked.

What if I found some typos in the code?

To avoid potential conflicts, we encourage people to use PRs to address minor issues like fixing typos. Thanks!