Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation #1

Open
sestinj opened this issue Sep 2, 2023 · 0 comments
Open

Update Documentation #1

sestinj opened this issue Sep 2, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@sestinj
Copy link
Contributor

sestinj commented Sep 2, 2023

A feature is never complete until it's documented! If you see anything out-of-date or that ought to be better explained, please edit the file and make a PR.

  • Starting at the root of the repo, navigate to the file you want to edit

  • Click the edit button as seen below:
    Image

  • This will tell you that you must fork the repository to proceed. Click "Fork this repository"

  • Use the editor that appears to make the desired changes. Once you're ready, click "Commit Changes..."

Image

  • This will open up the dialog box you see here. Optionally, you can give a message explaining the changes. Click "Commit Changes"

  • Finally, you'll be taken to an overview of your changes. Click "Create pull request" and you're good to go! You can always make additional changes and these will be shown in the same pull request.

  • We'll review your code as soon as time allows, possibly ask follow-up questions, and then merge it into the main repository.

@sestinj sestinj added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Status: Contribute without Coding
Development

No branches or pull requests

1 participant