Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 3.25 KB

Contributing to API-SDK Project

Welcome to Freshworks API SDK contributing guide. Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on API-SDK Docs.

Check our contribution options to see what types of contributions we accept before making changes. Read our contribution guidelines to adhere to our documentation standards.

In this guide you will get an overview of the contribution workflow from adding new API specification, adding a new endpoint, adding a new API method, adding test cases, creating a PR, reviewing, and merging the PR.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

Before you start kindly ensure you have the prerequisites

Getting started

To navigate our codebase with confidence, see the introduction to working on API-SDK docs in the contributing repository 🎊. For more information on writing markdown files on GitHub, kindly checkout this GitHub Markdown reference.

Make changes in a codespace

For more information about using a codespace for working on GitHub documentation, see "Working in a codespace." Before making any changes kindly explore supported contribution options

  • Create a working branch and start with your changes!
  • Commit your update in your branch. Commit the changes once you are happy with them.
  • Once your changes are ready, don't forget to self-review to speed up the review process⚡.

Pull Request

  • When you're finished with the changes, create a pull request, also known as a PR.
  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
  • Once you submit your PR, a person from DevRel team will review your contribution.
  • We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork/branch, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged

Congratulations 🎉🎉 The DevRel team thanks you for your contribution ✨. Once your PR is merged, your contributions will be publicly visible on the API-SDK Docs.