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

Latest commit

 

History

History
108 lines (75 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

108 lines (75 loc) · 3.89 KB
Raw

Contributing to Polycons

Thank you for wanting to contribute to polycons! This will guide you through everything you need to know to make changes and submit pull requests to the GitHub repository.

Opening Issues

One of the easiest ways to contribute to this project is by opening issues. If you're reporting a bug, try to include detailed information including steps to reproduce it, and what you expected to happen. If you're suggesting a feature or enhancement, please include information about your use case for it.

Getting Started

Start by forking or cloning the repository. GitHub's Guide is a great place to get started on this process.

Installing Dependencies

Install the dependencies needed with NPM:

$ npm i

Building

Building this project is accomplished by running the build script:

$ npm run build

This will build the project, generate the docs, lint the code, and run tests.

Testing

Any changes that you make to this project should be covered with tests. If you are adding new constructs to the library create a new file under the test/ directory.

This project uses jest testing framework. Please refer to the documentation on it if you are not familiar with it.

When writing tests, group together common functionality under test using a describe function. Individual tests are written in it functions. For example:

describe("a polycon", () => {

  it("cannot be instantiated without a factory", () => {
    const app = new App();
    expect(
      () => new Dog(app, "dog", { name: "piffle", treats: 5 })
    ).toThrowError(/Cannot find a Polycon factory \(directly or indirectly\)/);
  });

  it("cannot be instantiated if the registered factory does not support it", () => {
    const app = new App();
    Polycons.register(app, new PoodleFactory());
    expect(() => new Cat(app, "cat", { scritches: 5 })).toThrowError(
      /Type test\.cat not implemented/
    );
  });

});

All changes need to have tests. Feature changes should have full test coverage and bug fixes should be verified first through new tests.

All tests can be run using the test script:

$ npm run test

During a lot of active development you may find it useful to watch for changes and automatically re-run the tests:

$ npm run test:watch

Updating the README

Changes in core functionality should include changes to the README.md file explaining the functional changes. Please consider this when submitting changes. If you feel there is no need to change the README or documentation, state your reason when submitting the pull request. A lack of updates to the README may cause a delay in a pull request being merged.

Submitting a pull request

To ensure pull requests are reviewed and accepted as quickly as possible, please make sure:

  • Tests are written for all changes.
  • README.md is updated if new features are being added.
  • npm run build has been run to lint, build, and update API docs.
  • Commit messages are clear and descriptive and pushed to your fork.
  • Your fork is in sync with the upstream repository.

Create a new pull request here, selecting your fork for the 'compare' and main for the 'base'.

The title of the pull request should adhere to conventional commits. For example, if you're adding new features, the pull request title should start with feat:. If you are fixing a bug, then fix: should be the title prefix.

In the description reference any open issues that the changes resolve. Describe the changes you made and include anything you think would be useful for a reviewer to know. It's also a great place to add a shout-out to anyone who helped with the changes.