<commit_before>---
layout: default
title: Contributing
---

<div class="wrapper">
  <div class="contributing-wrapper">

    <div class="page-title">
      Contributing to Istanbul
    </div>

    <p>
      blurb about how we'd love to have folks contribute to
      Istanbul.js.
    </p>

    <div class="page-heading">
      Opening an Issue
    </div>

    <p>
      Blurb about the sorts of information that we'd like to
      have included in pull requests as they're opened.
    </p>

    <div class="page-heading">
      Creating a Pull Request
    </div>

    <p>
      blurb about how pull requests work on the project.
    </p>

    <div class="page-heading">
      Code of Conduct
    </div>

    <p>
      we should probably have a code of conduct of some sort,
      to encourage people to be kind to each other.
    </p>

  </div>
</div><commit_msg>docs: took stab at writing contributing section fixes #3 (#11)<commit_after>---
layout: default
title: Contributing
---

<div class="wrapper">
  <div class="contributing-wrapper">

    <div class="page-title">
      Contributing to Istanbul
    </div>

    <p>We would love to have you contribute to the Istanbul project, be it:</p>
    <ul>
      <li>creating a detailed bug report.</li>
      <li>adding a cool new feature.</li>
      <li>fixing bugs.</li>
      <li>helping us with our documentation or website.</li>
    </ul>
    <p>No contribution is too small, and we love first time open-source contributors.</p>

    <div class="page-heading">
      Reporting a Bug
    </div>

    <p>
      To report a bug, simply open an issue on the appropriate GitHub repository
      in the organization.
    </p>
    <p>
      If you're not sure what component of Istanbul the issue might be occurring in,
      <a href="https://github.com/istanbuljs/nyc/issues/new" target="_blank">open an issue on nyc</a> Istanbul's command
      line client.
    </p>
    <p>
      Please provide the following information when drafting a bug report:
    </p>
    <ul>
      <li><strong>Expected Behavior</strong>: how should things be working?</li>
      <li><strong>Observed Behavior</strong>: what did you observe happening instead?</li>
      <li><strong>Code</strong>: provide a repository, or snippet of code, that reproduces the bug.</li>
      <li><strong>Environment Information</strong>: provide the following information about your environment:
        <ul>
          <li>your operating system.</li>
          <li>your Node.js version.</li>
          <li>your npm version.</li>
          <li>your project dependencies.</li>
        </ul>
      </li>
    </ul>

    <i>Here's a handy script you can run:</i>

    <code style="width: 50%" class="hljs language-bash">sh -c 'node --version; npm --version; npm ls' > output.txt</code>

    <div class="page-heading">
      Creating a Pull Request
    </div>

    <p>
      Have an idea for a cool new feature? want to contribute a bug fix? We'd love to
      have you contribute:
    </p>
    <ul>
      <li> Look through the existing issues and see if your idea is something new. </li>
      <li> Create a <a href="https://github.com/istanbuljs/nyc/issues" target="_blank"> new issue </a>, or comment on an existing issue that you would like to help solve:
        <ul>
          <li> it's usually best to get some feedback before proceeding to write code.</li>
        </ul>
      </li>

      <li> fork the appropriate Istanbul repo, and clone it to your computer:
        <ul>
          <li> GitHub has <a href="https://help.github.com/articles/using-pull-requests/" target="_blank"> great documentation </a> regarding writing your first pull request. </li>
        </ul>
      </li>

      <li> make sure that you write unit-test for any code that you write for Istanbul:</li>
    </ul>

    <div class="page-heading">
      Contributor Behavior
    </div>

    <p>
      Be kind to one another. We're striving to make Istanbul an inclusive environment that's great for first
      time open-source contributors.
    </p>
    <p>
      tldr; we value value constructive community interaction, over technical acumen.
    </p>

  </div>
</div>
{'fraction_non_alphanumeric': 0.11689563750301278, 'fraction_numerical': 0.001205109664979513, 'mean_word_length': 2.4991568296795954, 'pattern_counts': {'":': 0, '<': 117, '<?xml version=': 0, '>': 118, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2813874', 'n_tokens_mistral': 1258, 'n_tokens_neox': 1185, 'n_words': 478}