Skip to content

Commit 22b689e

Browse files
aniketsingh98571aniketsingh98571
authored
Add Readme.md, Contributing.md ,PR template and Issue template (#7)
* feat:added readme.md, contributing.md and a PR template * linking issue #1 * feat:added issue template, revert:moved issue and pr template to ./github
1 parent b93c5d0 commit 22b689e

File tree

4 files changed

+188
-23
lines changed

4 files changed

+188
-23
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
name: Issue Template
3+
about: Create a report to help us improve
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
## Issue Type
10+
11+
<!-- Mark the relevant option with an 'x' -->
12+
13+
- [ ] Bug Report
14+
- [ ] Feature Request
15+
- [ ] Documentation Update
16+
- [ ] Performance Improvement
17+
- [ ] Other
18+
19+
## Description
20+
21+
<!-- Provide a clear and concise description of the issue -->
22+
23+
## Current Behavior
24+
25+
<!-- Describe what currently happens -->
26+
27+
## Expected Behavior
28+
29+
<!-- Describe what you expected to happen -->
30+
31+
## Steps to Reproduce (for bugs)
32+
33+
<!-- Provide steps to reproduce the issue -->
34+
35+
1.
36+
2.
37+
3.
38+
39+
## Screenshots/Videos
40+
41+
<!-- If applicable, add screenshots or videos to help explain your issue -->
42+
43+
## Environment
44+
45+
<!-- Please complete the following information -->
46+
47+
- Next.js Version: [e.g., 15.0.2]
48+
- Node Version: [e.g., 20.x]
49+
- Browser: [e.g., Chrome, Safari]
50+
- Device: [e.g., Desktop, iPhone 14]
51+
52+
## Additional Context
53+
54+
<!-- Add any other context about the issue here -->
55+
56+
## Possible Solution
57+
58+
<!-- If you have suggestions on how to fix the issue -->
59+
60+
## Related Issues/PRs
61+
62+
<!-- Link any related issues or PRs using # -->
63+
64+
## Checklist
65+
66+
<!-- Mark completed items with an 'x' -->
67+
68+
- [ ] I have searched for similar issues
69+
- [ ] I have provided all the requested information
70+
- [ ] I have included relevant code snippets (if applicable)
71+
- [ ] I have included error messages (if applicable)

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
## Description
2+
3+
<!-- Provide a brief description of the changes in this PR -->
4+
5+
---
6+
7+
## Type of Change
8+
9+
<!-- Mark the relevant option(s) with an 'x' -->
10+
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Breaking change
14+
- [ ] Documentation update
15+
- [ ] Code refactoring
16+
- [ ] Other (please describe):
17+
18+
---
19+
20+
## Testing
21+
22+
<!-- Describe the tests you ran and how to reproduce them -->
23+
24+
- [ ] Unit tests added/updated
25+
- [ ] Integration tests added/updated
26+
- [ ] Manual testing performed
27+
28+
---
29+
30+
## Screenshots/Videos
31+
32+
<!-- If applicable, add screenshots or videos to help explain your changes -->
33+
34+
---
35+
36+
## Related Issues
37+
38+
<!-- Link any related issues using # followed by the issue number -->
39+
40+
Closes #
41+
42+
---
43+
44+
## Checklist
45+
46+
<!-- Mark completed items with an 'x' -->
47+
48+
- [ ] Code follows project style guidelines
49+
- [ ] Comments added for complex logic
50+
- [ ] Documentation updated
51+
- [ ] All tests passing
52+
- [ ] No new warnings generated
53+
- [ ] Self-review performed
54+
55+
---
56+
57+
## Additional Notes
58+
59+
<!-- Add any additional information that reviewers should know -->

‎CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing to Procedure Portfolio
2+
3+
Thank you for your interest in contributing to Procedure Portfolio! This document provides guidelines and instructions for contributing to this project.
4+
5+
---
6+
7+
## Getting Started
8+
9+
### Before You Code
10+
11+
1. **Check Existing Issues**
12+
13+
- Browse through [existing issues](https://github.com/proceduretech/proceduretech.github.io/issues)
14+
- If you find an interesting issue:
15+
- Comment on the issue: "I'd like to work on this"
16+
- Self-assign the issue
17+
- If you don't find a suitable issue:
18+
- Create a new issue describing the change you want to make.
19+
- Self-assign it.
20+
21+
2. **Create a Pull Request**
22+
- All PRs must be linked to an issue
23+
- Link your PR by including "Fixes #123" or "Relates to #123" in the PR description
24+
- This helps track the context of changes.

‎README.md

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,47 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1+
<div align="center">
2+
<img src="public/assets/logo.svg" alt="Procedure Logo" width="200"/>
3+
<h1>Procedure Portfolio</h1>
4+
<p>A modern, performant portfolio website showcasing capabilities and projects.</p>
5+
</div>
26

3-
## Getting Started
7+
---
48

5-
First, run the development server:
9+
## Table of Contents
610

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
11+
- [About](#about)
12+
- [Tech Stack](#tech-stack)
13+
- [Running Locally](#running-locally)
14+
- [Contributing](#contributing)
1615

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
16+
---
1817

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
18+
## About
2019

21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
20+
Procedure Portfolio is a dynamic web application built to demonstrate professional capabilities, showcase projects, and provide an interactive platform for potential clients or employers. The site features a clean, modern design with smooth transitions and responsive layouts.
2221

23-
## Learn More
22+
---
2423

25-
To learn more about Next.js, take a look at the following resources:
24+
## Tech Stack
2625

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
26+
- **Framework**: [Next.js 15](https://nextjs.org/) (React Framework)
27+
- **Styling**: [Tailwind CSS](https://tailwindcss.com/)
28+
- **Deployment**: GitHub Pages
29+
- **UI Components**: Custom components with Headless UI
30+
- **Performance**: Server-side rendering and static generation
31+
- **Type Safety**: TypeScript
2932

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

32-
## Deploy on Vercel
35+
## Running Locally
3336

34-
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.
37+
1. Clone the repository: `git clone https://github.com/proceduretech/proceduretech.github.io.git`
38+
2. Navigate to the project directory: `cd proceduretech.github.io`
39+
3. Install dependencies: `npm install` or `yarn install`
40+
4. Start the development server: `npm run dev` or `yarn dev`
41+
5. Open the website in your browser: `http://localhost:3000`
3542

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
43+
---
44+
45+
## Contributing
46+
47+
We welcome contributions to improve the website's functionality and design. Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to submit improvements and bug fixes.

0 commit comments

Comments
 (0)