Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 3.78 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 3.78 KB
Raw

Contributing to Testsigma

Testsigma docs are built using Gatsby and deployed to https://testsigma.com/docs/.

If you feel insecure about how to start contributing, feel free to ask us on our Discord Server, in the #contributors channel.

Code Of Conduct

Read our Code of Conduct before contributing

Getting Started

We use Github Flow, so all code changes happen through pull requests. Learn more.

  1. Please make sure there is an issue associated with the work that you're doing. If it doesn’t exist, create an issue.
  2. If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also.
  3. Fork the repo and create a new branch from the main branch.
  4. Please name the branch as issue-[issue-number]-[issue-name(optional)]. For example, if you are fixing Issue #205 name your branch as issue-205 or issue-205-newdoc-for-rest-api-tesing .
  5. Squash your commits and refer to the issue using Fix #<issue-no> in the commit message, at the start.
  6. Rebase main with your branch and push your changes.

Setup for local development

  1. Git clone: git clone git@github.com:testsigmahq/testsigma-docs.git
  2. cd testsigma-docs
  3. Create a branch git checkout -b issue-[issue-number]-[issue-name(optional)]
  4. cd testsigma-docs
  5. npm install
  6. npm start

Now you can access docs on your local server using http://localhost:8000/docs/

Committing code

The main branch (protected) contains the code that is tested and released. Pull requests should be made against the main branch. main contains all of the new features and fixes that are under testing and ready to go out in the next release.

Once you are done with the code changes on your local machine, follow the below steps to commit.

Commit & Create Pull Requests

  1. Please make sure there is an issue associated with the work that you're doing. If it doesn’t exist, create an issue.
  2. Squash your commits and refer to the issue using Fix #<issue-no> in the commit message, at the start.
  3. Rebase main with your branch and push your changes.
  4. Once you are confident in your code changes, create a pull request in your fork to the main branch in the testsigmahq/testsigma-docs base repository.
  5. Link the issue of the base repository in your Pull request description. Guide

For all contributions, a CLA (Contributor License Agreement) needs to be signed here before (or after) the pull request has been submitted. A bot will prompt contributors to sign the CLA via a pull request comment, if necessary.

Commit messages

  • The first line should be a summary of the changes, not exceeding 50 characters, followed by an optional body that has more details about the changes. Refer to this link for more information on writing good commit messages.
  • Don't add a period/dot (.) at the end of the summary line.

Notes

  • Docs are currently deployed manually. Changes will not reflect immediately after a PR gets merged.
  • The search is powered by Algolia and is updated every day. Your local changes will not be reflected in search results.