Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 1.83 KB
Raw

Contributing to Documenso

If you plan to contribute to Documenso, please take a moment to feel awesome ✨ People like you are what open source is about ♥. Any contributions, no matter how big or small, are highly appreciated.

Before getting started

  • Before jumping into a PR be sure to search existing PRs or issues for an open or closed item that relates to your submission.
  • Select and issue from here or create a new one
  • Consider the results from the discussion in the issue

Developing

  • The development branch is main. All pull request should be made against this branch.
  • If you need help getting started, join us on Discord.
  • Use Conventional Commits to keep everything nice and clean.
  • Choose your branch name using the issue you are working on and a coventional commit type.
  1. Fork this repository to your own GitHub account and then clone it to your local device.
  2. Create a new branch:

  • Create a new branch (include the issue id and something readable):

    git checkout -b feat/doc-999-somefeature-that-rocks
  1. See the Developer Setup for more setup details.

Building

Note Please be sure that you can make a full production build before pushing code or creating PRs.

You can build the project with:

npm run build

Making a Pull Request

When making a pull request, be sure to add a changeset when something has changed with Documenso.

npm run changeset