Skip to content

Contributing to Rock

Jump to bottom Edit New page
Nick Airdo edited this page May 17, 2021 · 5 revisions

Contributing to Rock

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Rock and its packages, which are hosted in the Spark Development Network organization on GitHub. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Table Of Contents

What should I know before I get started?

How Can I Contribute?

Styleguides

Additional Notes

What should I know before I get started?

License

By contributing your code, you agree to license your contribution under the Rock Community License Agreement. We also need you to sign and send a scanned copy of the Spark Contributor Agreement back to the Spark Secretary (Secretary @ sparkdevnetwork.org ) to keep the lawyer off our backs.

Rock and Plugins

The power of Rock is that it isn't limited by what the core team provides. Instead the community is able to extend Rock to the furthest reaches of their creativity and abilities. Rock can be extended through plugins, themes, workflow actions, jobs, and external applications added through the Rock Shop or manually. Because Rock is so extensible, it's possible that a feature you've become accustomed to in Rock, or an issue you're encountering isn’t coming from a bundled feature at all, but rather a plugin you’ve installed. Contact information for products purchased in the Rock Shop are available on the item page in the store.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Rock. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible and be sure to fill out the provided template.

Before Submitting A Bug Report

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Rock, e.g. which command exactly you used in the terminal, or how you started Rock otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Rock command, and if so which one?
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

  • Can you reproduce the problem on a fresh install or the demo site?
  • Did the problem start happening recently (e.g. after updating to a new version of Rock) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of Rock? What's the most recent version in which the problem doesn't happen?
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
  • Include details about your configuration and environment including Rock Version, Client Culture Setting and which (if any) plugins you have installed?

Suggesting Enhancements

The core team is not short on ideas -- we're short on people who can execute ideas. But, if you have an idea for enhancing Rock that is absolutely amazing we would like to know about it, and if you are a developer, we would love to guide you toward successfully executing that idea.

This section guides you through submitting an enhancement suggestion for Rock, including completely new features and improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. If you'd like, you can use this template to structure the information.

Before Submitting An Enhancement Suggestion

Based on the outcome of the above the core team may help shape your idea and ask you to implement it as a Pull Request provided you've already worked through Your First Code Contribution.

How Do I Submit A (Good) Enhancement Suggestion?

If you are not a developer or cannot hire one to help you execute your idea, we'd still like to know about your enhancement suggestion. We use a black book to capture your idea and ask that provide the following details:

  • Use a clear and descriptive title to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the idea. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Rock which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows.
  • Explain why this enhancement would be useful to most Rock users and isn't something that can or should be implemented as a plugin.
  • List some other sites or applications where this enhancement exists.
  • Specify which version of Rock you're using.

Template For Submitting Enhancement Suggestions

[Short description of suggestion]

**Steps which explain the enhancement**

1. [First Step]
2. [Second Step]
3. [Other Steps...]

**Current and suggested behavior**

[Describe current and suggested behavior here]

**Why would the enhancement be useful to most users**

[Explain why the enhancement would be useful to most users]

[List some other text editors or applications where this enhancement exists]

**Screenshots and GIFs**

![Screenshots and GIFs which demonstrate the steps or part of Rock the enhancement suggestion is related to](url)

**Rock Version:** [Enter Rock version here]

Your First Code Contribution

Unsure where to begin contributing to Rock? You can start by looking through these Status: Available issues:

  • [Status: Available] - issues which should only require a small amount of code, and a test or two.

If you want to read about using Rock or developing plugins for Rock, the Rock Documentation and Developer Guides are free and available online.

Pull Requests

  • When making changes keep the changes simple (i.e. don't refactor boldly) otherwise the git diff will obscure your change and make it difficult to quickly see the actual change.
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the ASPX, C#, CSS, JavaScript, and SQL styleguides.
  • Remember these Committing Your Code standards
  • Use a tool like GhostDoc to help document your methods.
  • Try a tool like CodeMaid (free, in the Visual Studio store). It will auto-align your code, add brackets to single-line if statements, remove unnecessary whitespace and more.

Styleguides

Git Commit Messages

Adhere to these standards.

  • Prefix each commit with a plus (+) or minus (-) sign.
  • Use the past tense ("Added feature" not "Add feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally via the (Fixes #0000) notation as your commit suffix.

C# and ASPX Styleguide

Adhere to the Rock Coding Standards.

Use the Rock vssettings file

  • Use braces, even for single line cases (for, if/else, etc.).
  • 4 spaces (no tabs)
  • Insert space within parenthesis ( a > b )
  • Insert space after colon for base of interface in type declaration, after commas, after semicolons in "for" statement, and before colon for base or interface in type declaration
  • Use the Organize Usings | Remove and Sort tools when editing .cs files. Sort your usings putting 'System' directives first.

CSS and LESS Styleguide

Adhere to the Code Guide.

JavaScript Styleguide

Adhere to the Code Guide.

  • Use IDs, not classes as selectors $('#hfItemId_' + this.options.controlId);
  • camelCasing for all variable declarations
  • PascalCasing for class declarations
  • 2 spaces (no tabs)
  • strict mode

SQL Styleguide

Adhere to the Code Guide.

  • Capitalize reserved words
  • Main keywords on new line
  • Use brackets around table and column names
  • Use proper capitalization for table and column names

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests. Most labels are used across all SparkDevNetwork repositories, but some are specific to SparkDevNetwork/Rock.

Type of Issue and Issue State

Label name Description
Type:enhancement Feature requests. We don't track feature requests here, instead they go into the Ideas board at http://community.rockrms.com/Ideas.
Type: Bug Confirmed bugs or reports that are very likely to be bugs.
Status: Available Less complex issues which would be good first issues to work on for users who want to contribute to Rock.
Status: Confirmed Issues that have been confirmed by another party.
Not Yet Reproduced Likely bugs, but haven't been reliably reproduced.
Type: Duplicate Issues which are duplicates of other issues, i.e. they have been reported before.
Status: Unable/Cannot Fix The Rock core team has decided not to fix these issues for now, either because they're working as intended or for some other reason.

Topic Categories

Label name SparkDevNetwork/Rock 🔎 SparkDevNetwork‑org 🔎 Description
documentation search search Related to any type of documentation.
performance search search Related to performance.
security search search Related to security.
lava search search Related to Lava.
ui search search Related to visual design.
api search search Related to Rock’s public APIs.
uncaught-exception search search Issues about uncaught exceptions.
crash search search Reports of Rock completely crashing.
git search search Related to Git functionality (e.g. problems with gitignore files or with showing the correct file status).

SparkDevNetwork/Rock Topic Categories

Label name SparkDevNetwork/Rock 🔎 SparkDevNetwork‑org 🔎 Description
installer search search Related to the Rock installer.
updater search search Related to the Rock updater.

Pull Request Labels

Label name SparkDevNetwork/Rock 🔎 SparkDevNetwork‑org 🔎 Description
work-in-progress search search Pull requests which are still being worked on, more changes will follow.
needs-review search search Pull requests which need code review, and approval from maintainers or Rock core team.
under-review search search Pull requests being reviewed by maintainers or Rock core team.
requires-changes search search Pull requests which need to be updated based on review comments and then reviewed again.
needs-testing search search Pull requests which need manual testing.

This document was graciously created by community member extraordinaire, Garrett Johnson

Add a custom footer
Add a custom sidebar
Clone this wiki locally