Skip to content

Latest commit

 

History

History
114 lines (68 loc) · 7.32 KB

CONTRIBUTING.md

File metadata and controls

114 lines (68 loc) · 7.32 KB
Raw

Contributing to Testsigma

Thank you for your interest in Testsigma and for taking the time to contribute to this project. 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.

How can I contribute?

There are many ways in which you can contribute to Testsigma.

👥 Join the community

  Join our Discord server, help others use Testsigma for their test automation requirements.

🖋️ Blog about Testsigma

  We display blogs featuring Testsigma on our Blogs page. If you'd like your blog to be published here, write to us at [email protected].

🗣️ Give a talk about Testsigma

  You can talk about Testsigma in online/offline meetups. Drop a line to [email protected] ahead of time and we'll send you some swag. 👕

🧩 Build an Add-on

  Enhance Testsigma’s automation capabilities by building add-ons to solve unique test automation problems. Check out Contribution Guide for more details.

🐞 Report a bug

  Report all issues through GitHub Issues using the Report a Bug template. Provide as much information as you can.

🛠 Create a feature request

  We welcome all feature requests, whether for new features or enhancements to existing features. File your feature request through GitHub Issues using the Feature Request template.

📝 Improve the documentation

  Suggest improvements to our documentation using the Documentation Improvement template or check out our Docs Contribution Guide. Testsigma docs are published on here

📚 Contribute to Tutorials

  You can help by suggesting improvements to our tutorials using the Tutorials Improvement template or create a new tutorial. Checkout Tutorials Contribution Guide for more details.

⚙️ Write code to fix a Bug / new Feature Request

  We welcome contributions that help make testsigma bug-free & improve the test automation experience for our users. You can also find issues tagged Good First Issues. Check out the below sections to begin.

 

Writing Code

All submissions, including submissions by project members, require review. Before raising a pull request, ensure you have raised a corresponding issue and discussed a possible solution with a maintainer. This gives your pull request the highest chance of getting merged quickly. Join our Discord Server if you need any help.

First-time contributors

We appreciate first-time contributors and we are happy to assist you in getting started. In case of questions, just reach out to us! You find all issues suitable for first-time contributors here.

Repo overview

TestsigmaHQ/testsigma is a mono-repo consisting of 4 components:

  1. Server
  2. Agent
  3. Automator
  4. UI

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.

Set up your branch to write code

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 dev branch.
  4. Please name the branch as issue-[issue-number]-[issue-name(optional)] or feature-[feature-number]–[feature-name(optional)]. For example, if you are fixing Issue #205 name your branch as issue-205 or issue-205-selectbox-handling-changes
  5. Squash your commits and refer to the issue using Fix #<issue-no> in the commit message, at the start.
  6. Rebase dev with your branch and push your changes.
  7. Raise a pull request against the staging branch of the main repository.

🏡 Setup for local development

Refer to this document to learn how to set up a dev environment.

 

Committing code

The repository contains two important (protected) branches.

  • main contains the code that is tested and released.
  • dev contains recent developments under testing. This branch is set as the default branch, and all pull requests should be made against this branch.

Pull requests should be made against the dev branch. staging contains all of the new features and fixes that are under testing and ready to go out in the next release.

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 dev 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 dev branch in the testsigmahq/testsigma base repository.
  5. Link the issue of the base repository in your Pull request description. Guide
  6. Fill out the Pull Request Template completely within the body of the PR. If you feel some areas are not relevant add N/A but don’t delete those sections.

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.