New contributors: start here!

[hey-august]

Thank you for your interest in contributing to the FreeSWITCH docs!

Pull Request process

This is a high-level overview of the workflow for contributing to this docs repo. There are other ways of working with Git and Github, but this is the workflow we recommend.

Prerequisites:

• GitHub account
• The VSCode editor installed
• Git installed

You'll likely need to log in to Github from VSCode.

If you're having difficulties installing or configuring Git, you can also use GitHub Desktop.

1. Fork the freeswitch-docs repository
2. Clone your fork of the repository
   • In VSCode, select the "Clone Git Repository" button on the Welcome screen
3. Create a branch to store your changes
   • In VSCode, select "main" in the bottom left. Name your new branch something like username-issue-summary.
4. Make the changes.
5. Stage and commit your changes using the Source Control panel.
6. VSCode will likely warn you that you can't make a branch directly, and instead prompt you to create a fork. Do so.
7. Go to the Pull Requests page for the repo.
8. You should see a yellow banner asking if you'd like to make a Pull Request from your changes. Give it a descriptive title, and link the issue. Select create, and the issue is ready for review!

Good first issues

Browse the issues section of the repository and filter for the good-first-issue and type/epic tags.

Resources

• SignalWire docs style guide

[lizargall]

Note, click is not a surface agnostic UI term. Select is more inclusive, unless they MUST click ;-) https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/click