Skip to content

Latest commit

 

History

History
124 lines (77 loc) · 4.7 KB

CONTRIBUTING.md

File metadata and controls

124 lines (77 loc) · 4.7 KB
Raw

Contributing to OTNS

Contributor License Agreement (CLA)

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Code of Conduct

Help us keep OTNS open and inclusive. Please read and follow our Code of Conduct.

Bugs

If you find a bug in the source code, you can help us by submitting a GitHub Issue. Even better, you can submit a Pull Request with a fix.

New features

You can request a new feature by submitting a GitHub Issue.

If you would like to implement a new feature, please consider the scope of the new feature:

  • Large feature — Submit a GitHub Issue with your proposal so that the community can review and provide feedback first. Early feedback helps to ensure your proposal is accepted by the community, better coordinate our efforts, and minimize duplicated work.

  • Small feature — Can be implemented and directly submitted as a Pull Request without a proposal.

Contributing code

The OTNS Project follows the "Fork-and-Pull" model for accepting contributions.

Initial setup

Setup your GitHub fork and continuous integration services:

  1. Fork the otns repository by clicking Fork on the web UI.

Setup your local development environment:

# Clone your fork
git clone git@github.com:<username>/otns.git

# Configure upstream alias
git remote add upstream git@github.com:openthread/ot-ns.git

Pull requests

Branch

For each new feature, create a working branch:

# Create a working branch for your new feature
git branch --track <branch-name> origin/main

# Checkout the branch
git checkout <branch-name>

Create commits

# Add each modified file you'd like to include in the commit
git add <file1> <file2>

# Create a commit
git commit

This will open up a text editor where you can craft your commit message.

Upstream sync and clean up

Prior to submitting your pull request, it's good practice to clean up your branch and make it as simple as possible for the original repo's maintainer to test, accept, and merge your work.

If any commits have been made to the upstream main branch, you should rebase your development branch so that merging it will be a simple fast-forward that won't require any conflict resolution work.

# Fetch upstream main and merge with your repo's main branch
git checkout main
git pull upstream main

# If there were any new commits, rebase your development branch
git checkout <branch-name>
git rebase main

At this point, it might be useful to squash some of your smaller commits down into a small number of larger more cohesive commits. You can do this with an interactive rebase:

# Rebase all commits on your development branch
git checkout
git rebase -i main

This will open up a text editor where you can specify which commits to squash.

Coding conventions and style

OTNS requires all Go code be formatted with the gofmt program. Refer to go fmt your code for further guidance.

All style and coding suggestions in Effective Go should be followed, subject to the above rules.

OTNS uses golangci-lint in continuous-integration checks. You can run ./script/make-pretty and ./script/check-pretty to automatically reformat code and check for code-style compliance, respectively.

Push and test

# Checkout your branch
git checkout <branch-name>

# Push to your GitHub fork:
git push origin <branch-name>

This will trigger continuous-integration checks using GitHub Actions. You can view the status and logs via the "Actions" tab in your fork.

Submit the pull request

Once you've validated that all continuous-integration checks have passed, go to the page for your fork on GitHub, select your development branch, and click the Pull Request button. If you need to make any adjustments to your pull request, push the updates to GitHub. Your pull request will automatically track the changes on your development branch and update.