software engineering
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api
app
fs-monitor
sas
srs
README.md
how-to-run.md

README.md

CSC431: Intro to Software Engineering

Useful & Important Links

Contributing

For now, we'll use pull requests. Consult the guide for pull requests and how to submit one to this repository.

When everyone becomes more comfortable with git, everyone can become a contributor to this repository, which will allow you to commit without submitting a pull request.

LaTeX Style

  • Indent with two spaces
  • Lines should never be longer than 80 characters.

Code Style

We will use the Airbnb JavaScript Style Guide.

Why? Because it's simple, clean, and we can all refer to it. Now we don't have to argue over style choices and can instead focus on writing code.

The gist of it is

  • 2-space soft tabs: not a \t tab character.

  • Lines which are NOT longer than 80 characters.

  • function (arg1, arg2) { Note the spacing.

  • camelCase

  • const and let, not var

  • if-else blocks always with Egyptian braces.

    if (condition) {
      // ...
    } else {
      // ...
    }
  • Use ' instead of " for strings.

  • Use [] and {} for arrays and objects, respectively.

You can read the guide for the gritty details.