Skip to content

adding a CONTRIBUTING.md file #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bangfrog wants to merge 1 commit into
base: main
Choose a base branch
from
Open

adding a CONTRIBUTING.md file #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
This repository follows a fork model for contributions per:

https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project


Example workflow:

1. Create a fork of repo as github user.
2. Checkout the forked copy from your personal github account, e.g.:

git clone [email protected]:demo-contributing-user/singlestoredb-dev-image.git

3. Create a development branch:

# cd singlestoredb-dev-image
# git branch example-contribution
# git checkout example-contribution

4. Make and commit changes to your local repository and push upstream:

# git add CONTRIBUTING.md
# git commit -m "adding a contribution file"
# git push .

5. Submit your code upstream. A designated repository owner will review and
provide feedback or merge your contribution