Skip to content

Latest commit

 

History

History
125 lines (80 loc) · 5.12 KB

CONTRIBUTING.md

File metadata and controls

125 lines (80 loc) · 5.12 KB

Contributing to Custom Code Editor

🎉 Before we begin, thank you for taking the time to contribute! 🎉

We are open-source, and are thankful for any help we can get!

The following is a set of guidelines for contributing to Custom Code Editor, hosted here 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

  1. Code of Conduct
  2. What should I know before I get started?
  3. How Can I Contribute?
  4. Styleguides
  5. FAQ

Code of Conduct

This project and everyone participating in it is governed by this Code of Conduct (taking reference from Atom's code of conduct). By participating, you are expected to uphold this code.

Please report unacceptable behavior here.

What should I know before I get started?

  1. Read through the README file for prerequisites, installation details and configuration requirements.
  2. The editor is live here.
  3. If you want to contribute, see here.
  4. If you have a question, see the FAQ before opening an issue. It could be answered already

How can I contribute? ✋

Reporting Bugs 🐛

This section guides you through submitting a bug report for the Custom Code Editor.

Following these guidelines helps maintainers and the community...

  1. Understand your report
  2. Reproduce the behavior
  3. Find related reports

Guidelines for Reporting Bugs

  1. Perform a cursory search here for whether the issue has already been reported.
  2. Asumming no, please be as detailed as possible in describing the issue.
  3. Fill out the below template when opening an issue.

Issue template starts here

Description

Steps to Reproduce

Expected behavior:
Actual behavior:
Reproduces how often:

Versions

Additional Information

Issue template ends here

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.

Suggesting Enhancements

  1. Perform a cursory search here for whether the enhancement has already been suggested.
  2. If it has already been suggested, add a comment to that issue instead of opening a new issue.
  3. Asumming no, please do the following when describing the enhancements.
    • 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.
    • Include screenshots and animated GIFs if possible to demonstrate the steps or point out the part of Custom Code Editor the suggestion is related to.

Your First Code Contribution 🎉

Unsure where to begin contributing to Custom Code Editor? 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.

As for how to contribute to Open Source projects, follow this guide for a step-by-step walkthrough of opening a pull request.

Other useful references

Styleguides

Git Commit Messages

In general, we follow these guidelines to style commit messages. Keep them concise and informative.

Documentation Styleguide

In general, our documentation is written in Markdown, and we follow the Github Markdown Styleguide.

FAQ ❓

This is to be updated with more FAQ here as they come in. Future contributors are welcome!