Rules and Guidelines

General Rule

Be respectful of others.

Programming Rules

Collaboration is an essential element of programming, so being a good programmer means you are able to work well with others. One simple philosophy we can all adopt to become an excellent programmer is to Program with Empathy: think about how other programmers, program reviewer, your supervisor, and even yourself in the future will think about the code you just wrote. Adopting this philosophy means that we will practice the following:

1. Write simple code - simplify, simplify, simplify! While efficient code is great, take manageability of the code into consideration.
2. Write readable code - use variable names meaningfully! No one except you know what foo does.
3. Comment it - if it’s necessary to have complex code, write some comments to help guide the reader to understand the code.
4. Document it - whether it’s writing good message when you are committing a code change, writing a document for an API, or writing a documentation comments in the code, make sure that someone else can EASILY read and understand your code.

Guidelines

To find out what to contribute

1. Go to the project's Issues page on GitHub.
2. Find an issue with No Assignees that you would like to work on.
3. Read the issue’s description to understand the complexity and scope of the issue.
4. Assign yourself to the issue and get started working on it!

Issues requiring code changes

1. Fork the repository!
2. Clone the forked repository on your local computer.
3. Work on implementing the tasks to the cloned repository.
4. Push changes to the forked repository.

Submitting your contribution (without code changes)

1. For issues that do not require code changes, your contribution should be written in the issue itself as a form of comments.
2. If you believe you have completed the tasks given in the issue, then notify your team lead.
3. If your contribution satisfies the given tasks, then the team lead will close the issue and your contribution will be recorded.

Submitting your contribution (with code changes)

1. For issues requiring code changes, create a pull request (PR) and link the PR to the relevant issue (your team lead will be notified of the PR).
2. Your team lead will review the code changes to see if...
   1. the code works
   2. the code follows the Programming Rules
3. If your contribution satisfies the given tasks and meets the guidelines, then the team lead will merge the PR, close the relevant issue, and your contribution will be recorded.