Skip to main content

Contributing to OpenSign

Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.

Table of Contents​

  1. Getting Started
  2. Code of Conduct
  3. How Can I Contribute?
  4. Style Guidelines
  5. Community
  6. License

Getting Started​

  • Fork the OpenSign repository to your GitHub account.
  • Clone your fork locally: git clone https://github.com/your-username/OpenSign.git
  • Create a new branch for your contribution: git checkout -b feature/your-feature-name
  • Make your contributions.
  • Push your branch to your fork: git push origin feature/your-feature-name
  • Create a Pull Request from your fork to the OpenSign repository.

Code of Conduct​

We expect all our contributors to adhere to the Code of Conduct. Please read it thoroughly before contributing.

How Can I Contribute?​

Reporting Bugs​

  • Check the Issues to see if the bug has already been reported. If it has, add any additional information in the comments.
  • If the bug hasn’t been reported, create a new issue. Please provide as much information as possible to help maintainers reproduce the bug.

Suggesting Enhancements​

  • Use the Issues section to suggest any enhancements or new features.
  • Clearly describe your suggestion, explaining the problem it solves or the functionality it adds.

Pull Requests​

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Style Guidelines​

Git Commit Messages​

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less

JavaScript Style Guide​

Adhere to the Standard JavaScript Style Guide.

Community​

Engage with the community on our Gitter Channel or join our monthly community calls. Details can be found on our Community Page.

License​

By contributing, you agree that your contributions will be licensed under its AGPL v3 License.