Skip to content

Latest commit

 

History

History
148 lines (100 loc) · 5.63 KB

CONTRIBUTING.md

File metadata and controls

148 lines (100 loc) · 5.63 KB
Raw

Contributing to @microsoft/fetch-event-source

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Using the issue tracker

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest main or development branch in the repository.

  3. Isolate the problem — ideally create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/fetch-event-source.git
# Navigate to the newly cloned directory
cd fetch-event-source
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/Azure/fetch-event-source.git

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout main
git pull upstream main

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream main

  5. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  6. Open a Pull Request with a clear title and description. As part of your PR, also:

    a. Update the version in package.json, but do not publish it yet: wait till the PR has been reviewed. If you need a version published before this, you can use prerelease tags: set the package version to something like 6.0.0-prerelease.7 and run npm publish . --tag prerelease.

    b. Update the changelog with your changes.

Cutting a release

Once the PR has been reviewed, follow these steps to cut a release:

  1. Squash and merge your PR. Copy the PR description into the commit text.

  2. Once the PR has been merged, tag the merge commit with the version:

    a. git checkout main && git pull origin main

    b. git tag v<packageVersion> (e.g., git tag v6.0.0)

    c. git push origin v<packageVersion>

  3. Create a new github release on the new tag. Use the tag name as the release title and the copy the changelog into the description.

IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the MIT License.