Skip to content

Latest commit

 

History

History
336 lines (258 loc) · 29.2 KB

CONTRIBUTING.md

File metadata and controls

336 lines (258 loc) · 29.2 KB
Raw

That's correct, at least for linking existing material and, overall, providing and overview of the project and the (now many) components.

As for the "CONTRIBUTING" document, I will prepare something inspired by this, according to these general guidelines.

Contributing to CoderBot

👍🤖 Thanks for your interest in the CoderBot project! 🤖👍

The following is a set of guidelines for contributing to CoderBot and its modules, which are hosted in the CoderBot Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

What should I know before I get started?

How Can I Contribute?

Styleguides

Additional Notes

Code of Conduct

This project and everyone participating in it is governed by the CoderBot Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

What should I know before I get started?

CoderBot project description

CoderBot is an open source project with the objective of providing the hardware and software used in the educational robot with the same name.

It is composed by several repositories. When you initially consider contributing to CoderBot, you might be unsure about which of those repositories implements the functionality you want to change or report a bug for. This section should help you with that.

Package Conventions

CoderBot architecture

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for CoderBot. 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. Fill out the required template, the information it asks for helps us resolve issues faster.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting A Bug Report

  • TODO

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 by filling in the template.

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.

Provide more context by answering these questions:

° TODO

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for CoderBot, including completely new features and minor 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. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

Before Submitting An Enhancement Suggestion

How Do I Submit A (Good) Enhancement Suggestion?

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

  • Use a clear and descriptive title for the issue 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 steps. 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.
  • Explain why this enhancement would be useful to most CoderBot users and isn't something that can or should be implemented as a community package.
  • List some other text editors or applications where this enhancement exists.

Your First Code Contribution

Unsure where to begin contributing to CoderBot? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

Local development

  • TODO

Pull Requests

The process described here has several goals:

  • Maintain CoderBot's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible CoderBot
  • Enable a sustainable system for CoderBot's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing
    What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added 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 after the first line
  • When only changing documentation, include [ci skip] in the commit title

JavaScript Styleguide

All JavaScript code is linted with Prettier.

  • Prefer the object spread operator ({...anotherObj}) to Object.assign()
  • Inline exports with expressions whenever possible 
    // Use this:
export default class ClassName {

}

// Instead of:
class ClassName {

}
export default ClassName
  • Place requires in the following order:
    • Built in Node Modules (such as path)
    • Local Modules (using relative paths)
  • Place class properties in the following order:
    • Class methods and properties (methods starting with static)
    • Instance methods and properties

Documentation Styleguide

  • Use Markdown.
  • Reference methods and classes in markdown with the custom {} notation:
    • Reference classes with {ClassName}
    • Reference instance methods with {ClassName::methodName}
    • Reference class methods with {ClassName.methodName}

Example

  • TODO

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 CoderBot repositories.

GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in. The labels are loosely grouped by their purpose, but it's not required that every issue has a label from every group or that an issue can't have more than one label from the same group.

Type of Issue and Issue State

Label name CoderBotOrg 🔎 CoderBot‑org 🔎 Description
enhancement search search Feature requests.
bug search search Confirmed bugs or reports that are very likely to be bugs.
question search search Questions more than bug reports or feature requests (e.g. how do I do X).
feedback search search General feedback more than bug reports or feature requests.
help-wanted search search The CoderBot core team would appreciate help from the community in resolving these issues.
beginner search search Less complex issues which would be good first issues to work on for users who want to contribute to CoderBot.
more-information-needed search search More information needs to be collected about these problems or feature requests (e.g. steps to reproduce).
needs-reproduction search search Likely bugs, but haven't been reliably reproduced.
blocked search search Issues blocked on other issues.
duplicate search search Issues which are duplicates of other issues, i.e. they have been reported before.
wontfix search search The CoderBot core team has decided not to fix these issues for now, either because they're working as intended or for some other reason.
invalid search search Issues which aren't valid (e.g. user errors).
package-idea search search Feature request which might be good candidates for new packages, instead of extending CoderBot or core CoderBot packages.
wrong-repo search search

Topic Categories

Label name CoderBotOrg/backend 🔎 CoderBotOrg‑org 🔎 Description
windows search search Related to CoderBot running on Windows.
linux search search Related to CoderBot running on Linux.
mac search search Related to CoderBot running on macOS.
documentation search search Related to any type of documentation (e.g. API documentation and the flight manual).
performance search search Related to performance.
security search search Related to security.
ui search search Related to visual design.
api search search Related to CoderBot's public APIs.
uncaught-exception search search Issues about uncaught exceptions.
crash search search Reports of CoderBot completely crashing.
auto-indent search search Related to auto-indenting text.
encoding search search Related to character encoding.
network search search Related to network problems or working with remote files (e.g. on network drives).
git search search Related to Git functionality (e.g. problems with gitignore files or with showing the correct file status).

CoderBotOrg/backend Topic Categories

Label name CoderBotOrg/backend 🔎 CoderBotOrg‑org 🔎 Description
editor-rendering search search Related to language-independent aspects of rendering text (e.g. scrolling, soft wrap, and font rendering).
build-error search search Related to problems with building CoderBot from source.
error-from-pathwatcher search search
error-from-save search search Related to errors thrown when saving files.
error-from-open search search Related to errors thrown when opening files.
installer search search Related to the CoderBot installers for different OSes.
auto-updater search search Related to the auto-updater for different OSes.
deprecation-help search search Issues for helping package authors remove usage of deprecated APIs in packages.
electron search search

Pull Request Labels

Label name CoderBotOrg/backend 🔎 CoderBotOrg‑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 CoderBot core team.
under-review search search Pull requests being reviewed by maintainers or CoderBot 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.