Skip to content
This repository was archived by the owner on May 25, 2023. It is now read-only.

Latest commit

 

History

History
20 lines (13 loc) · 1.59 KB

File metadata and controls

20 lines (13 loc) · 1.59 KB

Contributing to code-stream-cli

Welcome! The code-stream-cli project team welcomes contributions from the community. Before you start working with code-stream-cli, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. You can either add the signature manually (Signed-off-by: John Doe john.doe@email.com) or use git commit --signoff.

Logging Bugs

Anyone can log a bug using the GitHub 'New Issue' button. Please use a short title and give as much information as you can about what the problem is, relevant software versions, and how to reproduce it. If you know the fix or a workaround include that too.

Code Contribution Flow

We use GitHub pull requests to incorporate code changes from external contributors. Typical contribution flow steps are:

  • Fork the code-stream-cli repo into a new repo on GitHub
  • Clone the forked repo locally and set the original code-stream-cli repo as the upstream repo
  • Make changes in a topic branch and commit
  • Fetch changes from upstream and resolve any merge conflicts so that your topic branch is up-to-date
  • Push all commits to the topic branch in your forked repo
  • Submit a pull request to merge topic branch commits to upstream master

If this process sounds unfamiliar have a look at the excellent overview of collaboration via pull requests on GitHub for more information.