This repo hosts the source code for the CS2103 (Software Engineering) module at SoC (NUS)
The released version of this website is available here. The released version may be behind the latest version in this repo.
We welcome contributions from current/past CS2103 students.
The easiest way to contribute is to post bugs and suggestion in our issue tracker.
If you would like to contribute code, here is the procedure:
- Fork this repo.
- Make sure what you want to contribute is already listed as an open issue in our issue tracker.
If it is not, post it as an issue first and wait for it to get accepted (an issue is considered
'accepted' when it is assigned a
priority.*
label). - You may choose an issue labeled
forFirstTimers
as your first issue, if there are any. But do not do more than oneforFirstTimers
issues. - Clone your fork onto your Computer.
- Create a branch. The branch name should be in the format
issue-number-some-key-words
, i.e. issue number followed by 2-4 key words related to the issue description, e.g.112-fix-loading-overlay-handbook
. - Implement your fix in the new branch.
- Use 2 spaces for indenting (not
tab
, not 4 or 8 spaces). - Minimize inline styles.
- When in doubt, you can refer to these style guides from the TEAMMATES project: JavaScript, CSS, HTML
- Use 2 spaces for indenting (not
- Test the code in your computer.
Tip: When testing local html files, some JavaScripts might not work in Firefox or Chrome. In that case you can use IE. Alternatively, you can start a web server in your Computer. - When the fix is ready,
- Ensure that your fork has the latest code from this repo (the repo you forked from is called
the
upstream
repo). The code in the upstream repo may have been updated while you were fixing the issue. If that is the case, sync your fork with upstream repo. - Stage your changes:
Your reviewer might want to see how your changes look like to a viewer of the website. To create a staging site using RawGit, commit your changes and push the branch to your fork. A running version of the website should now be available from the correspondingrawgit.com
URL of the formhttp://rawgit.com/user/repo/branch/
,
e.g. http://rawgit.com/acjh/website/112-fix-loading-overlay-handbook/. - Create a pull request (PR) against the
master
branch of this repo.
When naming the PR, copy and paste the name of the issue you are fixing, including the original issue number.
e.g.Fix size and position of 'Page Loading...' overlay in handbook page #112
.
In the PR description, mentionFixes #IssueNumber
(e.g.Fixes #112
) so that the corresponding issue is closed automatically when the PR is merged.
Remember to mention the URL of the staging site in your PR description. Here is an example. - Check the diff view of the PR to ensure it contains the intended changes only.
- Ensure that your fork has the latest code from this repo (the repo you forked from is called
the
- Your code will be reviewed by someone from the dev team. If the reviewer requests changes, revise the code, push the new commits to your branch, and post a comment to say the pull request is ready for review again.
- When your code is acceptable, it will be merged to this repo. Your fix will be included in the next release of the website.
- After your fix is merged, you may wish to create another PR to add your name to the
CONTRIBUTORS.md
file. There is no need to create a corresponding issue for that PR.
Many thanks to our contributors.