How to Contribute

:blue_book: The official home page for mobile-aware SWAM

https://mobile-swam.github.io

The official home page for mobile-aware SWAM

SWAM, the SWAM mascot

Coding Convention

Consistent code conventions are important for several reasons:

Please refer to Coding Conventions page.

Code Reviews and PRs

Please review incoming PRs; regardless whether you are a maintainer, a designated reviewer, or just a passer-by.

If you are a maintainer or reviewer of the specific component, you are obligated to review incoming related PRs within some reasonable time frame. However, even if you are not a reviewer (designated by committer or maintainers) or maintainer, as long as you are in this project, you need to give feedback on PRs especially if you are working on similar topics/components.

The submitter has the first responsibility of keeping the created PR clean and neat (rebase whenever there are merge conflicts), following up the feedback, testing when needed.

Any commits are required to be reviewed and approved before merged.

Signing off commits

Each commit is required to be signed-off by the corresponding author. With properly configured development environment, you can add sign-off for a commit with -s option (e.g., git commit -s). Here is some stories on signed-off.

What does it mean to sign off commits for authors?

It means that you are legally responsible for the given commit that, according to your best knowledge,

Usually, you are not allowed to push commits of other’s work; however, you may do so if you

From Torvalds’ (original author of Linux and git) git repo, you can refer to the documentation about git commit message tags.

Signed-off-by: this is a developer’s certification that he or she has the right to submit the patch for inclusion into the kernel. It is an agreement to the Developer’s Certificate of Origin, the full text of which can be found in submitting-patches.rst. Code without a proper signoff cannot be merged into the mainline.