Skip to content
This repository has been archived by the owner on Jul 14, 2023. It is now read-only.

Commit

Permalink
Improved contributor guide
Browse files Browse the repository at this point in the history
  • Loading branch information
nzakas committed Aug 27, 2015
1 parent a9e85e3 commit 0f08425
Show file tree
Hide file tree
Showing 8 changed files with 399 additions and 228 deletions.
50 changes: 50 additions & 0 deletions docs/developer-guide/code-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,56 @@ layout: doc

Programming language style guides are important for the long-term maintainability of software. This guide is based on the [Code Conventions for the Java Programming Language](http://java.sun.com/docs/codeconv/) and [Douglas Crockford's Code Conventions for the JavaScript Programming Language](http://javascript.crockford.com/code.html). Modifications have been made due to my personal experience and preferences.

## File Format

Each file has this same basic format:

```js
/**
* @fileoverview Description of the file
* @author Your Name
* @copyright 2015 Your Name. All rights reserved.
* See LICENSE file in root directory for full license.
*/

"use strict";

//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------

// require() statements

//------------------------------------------------------------------------------
// Helpers
//------------------------------------------------------------------------------

// private methods/data

//------------------------------------------------------------------------------
// Public Interface
//------------------------------------------------------------------------------

// exported objects/methods
module.exports = {

};
```

The `@author` field gives you credit for having created the file. The `@copyright` field indicates that you are the copyright holder for the file.

Your submission may touch other parts of the ESLint code that you did not write. In that case, you are welcome to add a copyright notice to the top of the file if you have done any amount of significant work on the file (we leave it up to you to decide what "significant" means - if you aren't sure, just ask). You should never change the `@author` field, but you can add another `@copyright` field on top of the existing ones, such as:

```js
/**
* @fileoverview Description of the file
* @author Author's Name
* @copyright 2015 Your Name. All rights reserved.
* @copyright 2014 Author's Name. All rights reserved.
* See LICENSE file in root directory for full license.
*/
```

## Indentation

Each indentation level is made up of four spaces. Do not use tabs.
Expand Down
228 changes: 0 additions & 228 deletions docs/developer-guide/contributing.md

This file was deleted.

22 changes: 22 additions & 0 deletions docs/developer-guide/contributing/changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Change Requests
layout: doc
---

# Change Requests

If you'd like to request a change to ESLint, please [create a new issue](https://github.com/eslint/eslint/issues/new?body=**What%20version%20are%20you%20using%3F**%0A%0A**What%20did%20you%20do%3F**%0A%0A**What%20happened%3F**%0A%0A**What%20did%20you%20expect%20to%20happen%3F**%0A%0A) on GitHub. Be sure to include the following information:

1. The version of ESLint you are using.
1. The problem you want to solve.
1. Your take on the correct solution to problem.

If you're requesting a change to a rule, it's helpful to include this information as well:

1. What you did.
1. What you would like to happen.
1. What actually happened.

Please include as much detail as possible to help us properly address your issue. If we need to triage issues and constantly ask people for more detail, that's time taken away from actually fixing issues. Help us be as efficient as possible by including a lot of detail in your issues.

**Note:** If you just have a question that won't necessarily result in a change to ESLint, such as asking how something works or how to contribute, please use the [mailing list](https://groups.google.com/group/eslint) instead of filing an issue.
34 changes: 34 additions & 0 deletions docs/developer-guide/contributing/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Contributing
layout: doc
---

# Contributing

One of the great things about open source projects is that anyone can contribute in any number of meaningful ways. ESLint couldn't exist without the help of the many contributors it's had since the project began, and we want you to feel like you can contribute and make a difference as well.

This guide is intended for anyone who wants to contribute to an ESLint project. Please read it carefully as it answers a lot of the questions many newcomers have when first working with our projects.

## [Signing the CLA](/cla)

In order to submit code or documentation to an ESLint project, please electronically sign the [Contributor License Agreement](http://eslint.org/cla). The CLA is you giving us permission to use your contribution.

## [Bug Reporting](bug-reporting)

Think you found a problem? We'd love to hear about it. This section explains how to submit a bug, the type of information we need to properly verify it, and the overall process.

## Proposing a [New Rule](new-rules)

We get a lot of proposals for new rules in ESLint. This section explains how we determine which rules are accepted and what information you should provide to help us evaluate your proposal.

## Requesting a [Change](changes)

If you'd like to request a change other than a bug fix or new rule, this section explains that process.

## [Working on Issues](working-on-issues)

Have some extra time and want to contribute? This section talks about the process of working on issues.

## Submitting a [Pull Request](pull-requests)

We're always looking for contributions from the community. This section explains the requirements for pull requests and the process of contributing code.
Loading

0 comments on commit 0f08425

Please sign in to comment.