How To Fork A Repo In Github

Contributing

Thanks for your involvement in helping us maintain our course notes! Nosotros are happy to consider contributions from faculty and students to assistance make these notes easier to apply and improve their correctness.

Requirements

These notes are congenital using Docusaurus, a modernistic static website generator. To use it, y'all'll demand to take the post-obit installed:

• an LTS version of node.js, which tin can exist checked by running node -5. Currently that's node.js 14.x, merely confirm with the official site.

• The yarn package manager, version >= 1.five (which tin be checked by running yarn --version).

• Visual Studio Code. This is not strictly necessary, but we encourage it since we use various extensions to make working on the site easier.

Installation

To install the dependencies, use:

Local Development

To develop the site, use:

This control starts a local development server and opens up a browser window. Nigh changes are reflected live without having to restart the server.

Workflows

If you lot desire to make a alter, please use the following GitHub workflow:

1. fork this repo on GitHub
2. clone your forked repo to your local automobile, git clone https://github.com/{your username}/Intro2C
3. create a new branch off of the main co-operative, git checkout -b {new branch name} main
4. make your changes and save
5. check it builds successfully, yarn build
6. check to see which files have changed, git status
7. phase these changed files in git, git add together file1 file2 ...
8. commit your changes, git commit -thousand "Fabricated the following changes..."
9. button your commits and branch to your fork, git push origin {new branch name}
10. create a Pull Request on GitHub
11. add a description about what yous changed and anything the maintainers need to know

Standardize frontmatter

Markdown documents can use the Markdown FrontMatter metadata fields, enclosed by a line --- on either side. We use id, title, sidebar_position, and clarification. Notwithstanding, nosotros do Non use slug for it.

Releases

Build

To create a product build, use:

This command generates static content in the build/ directory and can be served using any static contents hosting service, for example: GitHub Pages.

Deployment

To build and deploy to GitHub Pages, employ:

1. Follow footstep 1 - 5 in Docusaurus's Triggering deployment with GitHub Actions

2. Deploy your site to Github Pages, run:

• For Bash:

                              GIT_USER=<GITHUB_USERNAME> yarn deploy            

• For Windows

              GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy            

• For Powershell

              cmd /C 'ready "GIT_USER=<GITHUB_USERNAME>" && yarn deploy'            

If you lot are using GitHub pages for hosting, this command is a convenient way to build the website and push button to the gh-pages branch.

Miscellanous

Tutorial for Converting Table-like Diagrams into Images

To forbid table diagrams overflowing (and having the horizontal scrollbar on narrower viewports), nosotros use a simple technique to convert them to images. This allows us to have responsive diagrams with less endeavor and minimizes HTML syntax on our pages.

Tool Recommendation: Firefox Browser (easier to make screenshots)

1. Run the app (npm run offset)

2. Get to the browser

3. Go where the table you lot want to convert is

4. Right click, select "Take Screenshot"

5. Select an area that encloses the whole table

6. Make any adjustments necessary when cropping (avoid having unnecessary space)

7. Click Download

8. Save prototype to the /static/img folder in the repo

9. This is how it should end up looking similar:

10. Apply markdown to place the image wherever y'all need:

              !["Alt test for accessibility"](/img/proper noun-of-the-paradigm.png)                          

Source: https://github.com/rnrobson/software-testing-fork

Share this post