Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DJCrossman authored Aug 28, 2024
1 parent 0d3aa39 commit f9f045d
Showing 1 changed file with 32 additions and 8 deletions.
40 changes: 32 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Getting Started

First, run the development server:
Expand All @@ -18,6 +16,38 @@ You can start editing the page by modifying `pages/index.tsx`. The page auto-upd

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.

## Contributing

We highly encourage learning new technology and processes including contributing to open source software. We understand that not everyone will have the skill set but we would love to teach you a new skill. Below we have provided instructions to contribute to this private repository.

#### 1. Fork the repository

Forking a repository is a simple two-step process. We've created a repository for you to practice with!

1. On GitHub, navigate to the [HackRegina/website](https://github.com/HackRegina/website) repository.
2. In the top-right corner of the page, click Fork.

That's it! Now, you have a fork of the original HackRegina/website repository. [Read more on forking here](https://help.github.com/articles/fork-a-repo/).

#### 2. Make your changes

#### 3. Create a Pull Request

You can open a pull request to the upstream repository from any branch or commit in your fork.

1. Navigate to the original repository you created your fork from.
2. To the right of the Branch menu, click New pull request.
3. On the Compare page, click compare across forks.
4. Confirm that the base fork is the repository you'd like to merge changes into. Use the base branch drop-down menu to select the branch of the upstream repository you'd like to merge changes into.
5. Drop-down menus for choosing the head fork and compare branch. Use the head fork drop-down menu to select your fork, then use the compare branch drop-down menu to select the branch you made your changes in.
6. Type a title and description for your pull request.
7. If you do not want to allow anyone with push access to the upstream repository to make changes to your PR, unselect Allow edits from maintainers.
8. Click Create pull request.

[Read more on creating a pull request from a fork here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).

#### 4. We will do the rest!

## Learn More

To learn more about Next.js, take a look at the following resources:
Expand All @@ -26,9 +56,3 @@ To learn more about Next.js, take a look at the following resources:
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

0 comments on commit f9f045d

Please sign in to comment.