-
-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
125 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
# Contributing to Custom Code Editor | ||
|
||
:tada: Before we begin, thank you for taking the time to contribute! :tada: | ||
|
||
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](https://github.com/DhanushNehru/CustomCodeEditor) 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](#code-of-conduct) | ||
2. [What should I know before I get started?](#what-should-i-know-before-i-get-started) | ||
3. [How Can I Contribute?](#how-can-i-contribute) | ||
* [Reporting Bugs](#reporting-bugs) | ||
* [Suggesting Enhancements](#suggesting-enhancements) | ||
* [Your First Code Contribution](#your-first-code-contribution) | ||
4. [Styleguides](#styleguides) | ||
* [Git Commit Messages](#git-commit-messages) | ||
* [Documentation Styleguide](#documentation-styleguide) | ||
5. [FAQ](#faq) | ||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it is governed by this [Code of Conduct](https://github.com/atom/atom/blob/master/CODE_OF_CONDUCT.md) *(taking reference from Atom's code of conduct)*. By participating, you are expected to uphold this code. | ||
|
||
Please report unacceptable behavior [here](https://discord.com/invite/Yn9g6KuWyA). | ||
|
||
## What should I know before I get started? | ||
|
||
1. Read through the [README](README.md) file for prerequisites, installation details and configuration requirements. | ||
2. The editor is live [here](https://custom-code-editor.vercel.app/). | ||
3. If you want to contribute, see [here](#how-can-i-contribute). | ||
4. If you have a question, see the [FAQ](#faq) before opening an issue. It could be answered already | ||
|
||
## How can I contribute? :hand: | ||
|
||
### Reporting Bugs :bug: | ||
|
||
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](https://github.com/DhanushNehru/CustomCodeEditor/issues) 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 | ||
1. | ||
2. | ||
3. | ||
|
||
##### Expected behavior: | ||
* | ||
|
||
##### Actual behavior: | ||
* | ||
|
||
##### Reproduces how often: | ||
* | ||
|
||
#### Versions | ||
* | ||
|
||
#### Additional Information | ||
* | ||
|
||
> Issue template ends here | ||
--- | ||
|
||
#### NOTE :warning: | ||
|
||
* 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](https://github.com/DhanushNehru/CustomCodeEditor/issues) 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 :tada: | ||
|
||
Unsure where to begin contributing to Custom Code Editor? You can start by looking through these beginner and help-wanted issues: | ||
|
||
* [Beginner issues](https://github.com/DhanushNehru/CustomCodeEditor/labels/good%20first%20issue) - issues which should only require a few lines of code, and a test or two. | ||
* [Help wanted issues](https://github.com/DhanushNehru/CustomCodeEditor/labels/help%20wanted) - issues which should be a bit more involved than beginner issues. | ||
|
||
As for **how** to contribute to Open Source projects, follow [this guide](https://daily.dev/blog/how-to-contribute-to-open-source-projects-as-a-beginner) for a step-by-step walkthrough of opening a pull request. | ||
|
||
#### Other useful references | ||
|
||
* [Open Source Friday](https://opensourcefriday.com/) | ||
|
||
## Styleguides | ||
|
||
### Git Commit Messages | ||
|
||
In general, we follow [these guidelines](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53) to style commit messages. Keep them concise and informative. | ||
|
||
### Documentation Styleguide | ||
|
||
In general, our documentation is written in [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax), and we follow the [Github Markdown Styleguide](https://github.com/google/styleguide/blob/gh-pages/docguide/style.md). | ||
|
||
## FAQ :question: | ||
|
||
1. | ||
|
||
> This is to be updated with more FAQ here as they come in. Future contributors are welcome! |