Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

85 lines (54 loc) · 2.6 KB

How to contribute to sbtest

Thank you for considering contributing to this project!

General guidelines

  • Keep PRs short to simplify review
  • PRs should include changes only to files related to change
  • Avoid style only code based PRs

Reporting issues

Check if this issue is already fixed in the latest release. If not, please include the following information in your post:

  • Describe what you expected to happen.
  • Describe what actually happened.
  • Include the full traceback if there was an exception.

Submitting patches

You can work on any issue that doesn't have an open PR linked to it or a maintainer assigned to it. These show up in the sidebar. No need to ask if you can work on an issue that interests you.

First time setup

$ git config --global user.name 'your name'
$ git config --global user.email 'your email'

Clone/Fork Repository

  • Fork sbtest to your GitHub account (external contributors only)

  • Clone the main repository locally.

$ git clone https://github.com/{username}/sbtest
$ cd sbtest
  • Add fork as a remote to push your work to (external contributors only)
$ git remote add fork https://github.com/{username}/sbtest

Start coding

  • Create a branch to identify the issue you would like to work on.
$ git fetch origin
$ git checkout -b your-branch-name origin/main

  • Using your favorite editor, make your changes, and commit

  • Push your commits to your fork on GitHub (external contributors)

$ git push --set-upstream fork your-branch-name
  • Push your commits to your sbtest branch on GitHub (team contributors)
$ git push -u origin your-branch-name

Create a Pull Request

Resources

Based on the SiliconCompiler contribution guidelines