Skip to content
This repository has been archived by the owner on Jun 22, 2021. It is now read-only.

Latest commit

 

History

History
110 lines (96 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

110 lines (96 loc) · 4.04 KB
Raw

Contributing to scr-cli

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Questions/Problems

We use GitHub Discussions to answer your questions that might not require an issue ad a pull request.

Available discussion categories:

Submissions

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

The following workflow uses the GitHub CLI for illustration purposes, so feel free to use other Git compatible tools that you are familiar with.

Gitflow Workflow Atlassian. (2021). Gitflow Workflow. Atlassian; Atlassian. https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow

‌

  1. Fork the repo and create your branch from master/main.
# Clone your fork of the repo into the current directory
git clone https://github.com/AppleGamer22/scr-cli
# Navigate to the newly cloned directory
cd scr-cli
# Assign the original repo to a remote called "GitHub"
git remote add GitHub https://github.com/AppleGamer22/scr-cli
# Create a ew branch from HEAD
git branch <your branch>
  1. If you've added code that should be tested, add tests (.spec.ts files).
  2. If you've changed APIs, update the documentation.
  3. Ensure the test suite passes.
# Run client-side & server-side tests
npm test
# Run client-side tests
npm run test:client
# Run server-side tests
npm run test:server
  1. Commit & push your changes to your branch
# Commit all changed files with a message
git commit -am "<commit message>"
# Push changes to your remote GitHub branch
git push GitHub <your branch>
  1. Create a pull request
gh pr create [flags]
  1. Mark a pull request as ready for review if appropriate
gh pr ready [<number> | <url> | <branch>] [flags]
  1. Wait for others to review the pull request
  2. Close the pull request if appropriate
gh pr close [<number> | <url> | <branch>] [flags]

Bug Reports/Feature Requests

We use GitHub Issues to track public bugs. Report a bug by opening a new issue.

Your bug reports should have:

  • A quick summary and/or background
  • Steps to reproduce with:
    • Shell commands
    • Sample code
    • Configuration files
  • Expected behaviour
  • Actual behaviour
  • Notes about:
    • including why you think this might be happening,
    • or stuff you tried that didn't work

Coding Style

Our .editorconfig file:

root = true

[*]
charset = utf-8
indent_style = tab
indent_size = 4
insert_final_newline = false
trim_trailing_whitespace = true

[*.md]
max_line_length = off
trim_trailing_whitespace = false

[*.{yml, yaml}]
indent_style = space
indent_size = 2

License

When you submit code changes, your submissions are understood to be under the same GNU GPL-3 License that covers the project. Feel free to contact the maintainers if that's a concern.

By contributing, you agree that your contributions will be licensed under its GNU GPL-3 License.