Skip to content
This repository has been archived by the owner on Oct 30, 2018. It is now read-only.

Latest commit

 

History

History
60 lines (37 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

60 lines (37 loc) · 2.66 KB
Raw

Instructions for Logging Issues

1. Search for Duplicates

Search the existing issues before logging a new one.

2. Do you have a question?

The issue tracker is for issues, in other words, bugs and suggestions.

3. Did you find a bug?

When logging a bug, please be sure to include the following:

  • What version of Browser you're using
  • If at all possible, an isolated way to reproduce the behavior
  • The behavior you expect to see, and the actual behavior

4. Do you have a suggestion?

We also accept suggestions in the issue tracker.

In general, things we find useful when reviewing suggestions are:

  • A description of the problem you're trying to solve
  • An overview of the suggested solution
  • Examples of how the suggestion would work in various places
    • Code examples showing e.g. "this would be an error, this wouldn't"
    • Code examples showing the generated JavaScript (if applicable)

Instructions for Contributing Code

Contributing bug fixes

vsforce is currently accepting contributions in the form of bug fixes. A bug must have an issue tracking it in the issue tracker that has been approved ("Milestone == Community") by the vsforce team. Your pull request should include a link to the bug that you are fixing. If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort.

Contributing features

Features (things that add new or improved functionality to vsforce) may be accepted, but will need to first be approved (marked as "Milestone == Community" by a vsforce coordinator with the message "Approved") in the suggestion issue. Features with language design impact, or that are adequately satisfied with external tools, will not be accepted.

Design changes will not be accepted at this time. If you have a design change proposal, please log a suggestion issue.

Housekeeping

Your pull request should:

  • Include a description of what your change intends to do

  • Be a child commit of a reasonably recent commit in the master branch

    • Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR)

  • It is desirable, but not necessary, for the tests to pass at each commit

  • Have clear commit messages

    • e.g. "Refactor feature", "Fix issue", "Add tests for issue"

  • Include adequate tests

    • At least one test should fail in the absence of your non-test code changes. If your PR does not match this criteria, please specify why
    • Tests should include reasonable permutations of the target fix/change
    • Include baseline changes with your change
    • All changed code must have 100% code coverage