Skip to content

Latest commit

 

History

History
264 lines (186 loc) · 9.9 KB

CONTRIBUTING.md

File metadata and controls

264 lines (186 loc) · 9.9 KB
Raw

Contributing to socketioxide

We would love for you to contribute to socketioxide and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

Got a Question or Problem?

Please open a discussion on the Q&A discussions page. We want to keep GitHub Issues for bugs and feature requests. If you open an issue it will be moved to Discussions.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to our [GitHub Repository][github]. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. For your issue name, please prefix your proposal with [discussion], for example "[discussion]: your feature idea".
  • Small Features can be crafted and directly submitted as a Pull Request.

Submission Guidelines

Submitting an Issue

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using a repository or Gist. Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:

  • version of socketioxide used
  • version of socket.io protocol used
  • and most importantly - a use-case that fails

Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.

You can file new issues by filling out our [new issue form][new_issue].

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search [GitHub Pull Requests][gh_prs] for an open or closed PR that relates to your submission. You don't want to duplicate effort.

  2. Fork this repository.

  3. Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  4. Create your patch, including appropriate test cases.

  5. Follow our Coding Rules.

  6. Run the full socketioxide test suite (see common scripts), and ensure that all tests pass.

  7. Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  8. Push your branch to GitHub:

    git push origin my-fix-branch

  9. In GitHub, send a pull request to socketioxide:main.

  • If we suggest changes then:

    • Make the required updates.

    • Re-run the socketioxide test suites to ensure tests are still passing.

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase master -i
git push -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Development Setup

You will need rustc and cargo.

  1. Clone the socketioxide repository:

    git clone https://github.com/totodore/socketioxide

  2. To test socketioxide don't forget to enable the flag socketioxide_test through the RUSTFLAGS environment variable:

    export RUSTFLAGS="--cfg socketioxide_test"

  3. Depending on what you want to change, clone the socketio/engine.io-protocol repo or the socketio/socket.io-protocol repo or both

    git clone https://github.com/socketio/engine.io-protocol

  4. Install dependencies for the two test-suite repos with npm install (or yarn install)

    cd engine.io-protocol/test-suite
npm install
cd ../../socket.io-protocol/test-suite
npm install

  5. Run the e2e test server you want (in socketioxide/e2e)

    cargo run --bin engineioxide-e2e --features v3,v4
    cargo run --bin socketioxide-e2e --features v3,v4

  6. Run the corresponding test suite (in socketio/engine.io-protocol/test-suites or socketio/socket.io-protocol/test-suites)

    cd engine.io-protocol/test-suite && npm test
    cd socket.io-protocol/test-suite && npm test

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more unit-test.
  • The code must adhere to the rustfmt style guide. Run cargo fmt to check your code (all PRs with bad-formated code won't pass CI).

Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the socketioxide change log.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Footer should contain a closing reference to an issue if any.

Samples: (even more [samples][commits_samples])

docs(changelog): update change log to beta.5
fix(core): need to depend on latest rxjs and zone.js

Revert

If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • chore: Updating tasks etc; no production code change
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests
  • sample: A change to the samples

Scope

The scope should have the name of the cargo package affected (as perceived by person reading changelog generated from commit messages).

The following is the list of supported scopes:

  • socketio: for changes made on socketioxide directory
  • engineio: for changes made on engineioxide directory
  • examples: for changes made on examples directory
  • e2e: for changes made on e2e directory

If your change affect more than one package, separate the scopes with a comma (e.g. common,core).

There are currently a few exceptions to the "use package name" rule:

  • sample/#: for the example apps directory, replacing # with the example app number
  • none/empty string: useful for style, test and refactor changes that are done across all packages (e.g. style: add missing semicolons)

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.