Skip to content

Commit 6454987

Browse files
committed
Documentation Updates & Bug Fixes
1 parent 4e7399e commit 6454987

15 files changed

+814
-1031
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: nixrajput

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
assignees: ["nixrajput"]
6+
body:
7+
- type: input
8+
id: contact
9+
attributes:
10+
label: Contact Details
11+
description: How can we get in touch with you if we need more info?
12+
placeholder: ex. email@example.com
13+
validations:
14+
required: false
15+
- type: textarea
16+
id: what-happened
17+
attributes:
18+
label: What happened?
19+
description: Also tell us, what did you expect to happen?
20+
placeholder: Tell us what you see!
21+
validations:
22+
required: true
23+
- type: dropdown
24+
id: devices
25+
attributes:
26+
label: What devices are you seeing the problem on?
27+
multiple: true
28+
options:
29+
- Windows
30+
- Mac
31+
- Linux
32+
validations:
33+
required: true
34+
- type: input
35+
id: os
36+
attributes:
37+
label: OS Version
38+
description: On what version of OS is your device running?
39+
placeholder: Windows 11
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: logs
44+
attributes:
45+
label: Relevant log output
46+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
47+
render: shell
48+
- type: checkboxes
49+
id: terms
50+
attributes:
51+
label: Code of Conduct
52+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nixrajput/flutter_carousel_widget/CODE_OF_CONDUCT.md).
53+
options:
54+
- label: I agree to follow this project's Code of Conduct
55+
required: true
56+
- type: markdown
57+
attributes:
58+
value: "## Thanks for taking the time to fill out this bug report!"
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
title: "[Feature Request]: "
4+
labels: ["enhancement"]
5+
assignees:
6+
- nixrajput
7+
body:
8+
- type: input
9+
id: contact
10+
attributes:
11+
label: Contact Details
12+
description: How can we get in touch with you if we need more info?
13+
placeholder: ex. email@example.com
14+
validations:
15+
required: false
16+
- type: textarea
17+
id: feature
18+
attributes:
19+
label: Is your feature request related to a problem? Please describe.
20+
description: A clear and concise description of what the problem is.
21+
placeholder: Write here
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: solution
26+
attributes:
27+
label: Describe the solution you'd like
28+
description: A clear and concise description of what you want to happen.
29+
placeholder: Write here
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: alternatives
34+
attributes:
35+
label: Describe alternatives you've considered
36+
description: A clear and concise description of any alternative solutions or features you've considered.
37+
placeholder: Write here
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: additional-context
42+
attributes:
43+
label: Additional context
44+
description: Add any other context or screenshots about the feature request here.
45+
placeholder: Write here
46+
- type: checkboxes
47+
id: terms
48+
attributes:
49+
label: Code of Conduct
50+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nixrajput/flutter_carousel_widget/CODE_OF_CONDUCT.md).
51+
options:
52+
- label: I agree to follow this project's Code of Conduct
53+
required: true
54+
- type: markdown
55+
attributes:
56+
value: "## Thanks for taking the time to fill out this feature request form!"

.github/workflows/codeql.yml

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# For most projects, this workflow file will not need changing; you simply need
2+
# to commit it to your repository.
3+
#
4+
# You may wish to alter this file to override the set of languages analyzed,
5+
# or to provide custom queries or build logic.
6+
#
7+
# ******** NOTE ********
8+
# We have attempted to detect the languages in your repository. Please check
9+
# the `language` matrix defined below to confirm you have the correct set of
10+
# supported CodeQL languages.
11+
#
12+
name: "CodeQL"
13+
14+
on:
15+
push:
16+
branches: [ "master" ]
17+
pull_request:
18+
branches: [ "master" ]
19+
schedule:
20+
- cron: '30 01 * * 0'
21+
22+
jobs:
23+
analyze:
24+
name: Analyze (${{ matrix.language }})
25+
# Runner size impacts CodeQL analysis time. To learn more, please see:
26+
# - https://gh.io/recommended-hardware-resources-for-running-codeql
27+
# - https://gh.io/supported-runners-and-hardware-resources
28+
# - https://gh.io/using-larger-runners (GitHub.com only)
29+
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
30+
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
31+
timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
32+
permissions:
33+
# required for all workflows
34+
security-events: write
35+
36+
# required to fetch internal or private CodeQL packs
37+
packages: read
38+
39+
# only required for workflows in private repositories
40+
actions: read
41+
contents: read
42+
43+
strategy:
44+
fail-fast: false
45+
matrix:
46+
include:
47+
- language: c-cpp
48+
build-mode: autobuild
49+
# CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
50+
# Use `c-cpp` to analyze code written in C, C++ or both
51+
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
52+
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
53+
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
54+
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
55+
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
56+
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
57+
steps:
58+
- name: Checkout repository
59+
uses: actions/checkout@v4
60+
61+
# Initializes the CodeQL tools for scanning.
62+
- name: Initialize CodeQL
63+
uses: github/codeql-action/init@v3
64+
with:
65+
languages: ${{ matrix.language }}
66+
build-mode: ${{ matrix.build-mode }}
67+
# If you wish to specify custom queries, you can do so here or in a config file.
68+
# By default, queries listed here will override any specified in a config file.
69+
# Prefix the list here with "+" to use these queries and those in the config file.
70+
71+
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
72+
# queries: security-extended,security-and-quality
73+
74+
# If the analyze step fails for one of the languages you are analyzing with
75+
# "We were unable to automatically build your code", modify the matrix above
76+
# to set the build mode to "manual" for that language. Then modify this step
77+
# to build your code.
78+
# ℹ️ Command-line programs to run using the OS shell.
79+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
80+
- if: matrix.build-mode == 'manual'
81+
shell: bash
82+
run: |
83+
echo 'If you are using a "manual" build mode for one or more of the' \
84+
'languages you are analyzing, replace this with the commands to build' \
85+
'your code, for example:'
86+
echo ' make bootstrap'
87+
echo ' make release'
88+
exit 1
89+
90+
- name: Perform CodeQL Analysis
91+
uses: github/codeql-action/analyze@v3
92+
with:
93+
category: "/language:${{matrix.language}}"

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.vscode/
2+
data/
23

34
# Prerequisites
45
*.d

CODE_OF_CONDUCT.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Our Pledge
44

5-
We as members, contributors, and leaders pledge to make participation in our
5+
We as members, contributors, and leaders pledge to participate in our
66
community a harassment-free experience for everyone, regardless of age, body
77
size, visible or invisible disability, ethnicity, sex characteristics, gender
88
identity and expression, level of experience, education, socio-economic status,
@@ -15,7 +15,7 @@ diverse, inclusive, and healthy community.
1515
## Our Standards
1616

1717
Examples of behavior that contributes to a positive environment for our
18-
community include:
18+
community includes:
1919

2020
* Demonstrating empathy and kindness toward other people
2121
* Being respectful of differing opinions, viewpoints, and experiences
@@ -33,7 +33,7 @@ Examples of unacceptable behavior include:
3333
* Public or private harassment
3434
* Publishing others' private information, such as a physical or email
3535
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
36+
* Other conduct that could reasonably be considered inappropriate in a
3737
professional setting
3838

3939
## Enforcement Responsibilities
@@ -50,7 +50,7 @@ decisions when appropriate.
5050

5151
## Scope
5252

53-
This Code of Conduct applies within all community spaces, and also applies when
53+
This Code of Conduct applies within all community spaces and also applies when
5454
an individual is officially representing the community in public spaces.
5555
Examples of representing our community include using an official e-mail address,
5656
posting via an official social media account, or acting as an appointed
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at
63-
nkr.nikhil.nkr@gmail.com.
63+
<nkr.nikhil.nkr@gmail.com>.
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the
@@ -116,13 +116,13 @@ the community.
116116

117117
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118118
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
120120

121121
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122122
enforcement ladder](https://github.com/mozilla/diversity).
123123

124124
[homepage]: https://www.contributor-covenant.org
125125

126126
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
127+
<https://www.contributor-covenant.org/faq>. Translations are available at
128+
<https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing to the Bus Reservation System Management
2+
3+
We appreciate your interest in contributing to the Bus Reservation System Management developed using Object Oriented Programming (OOP) and File Handling concepts in C++. By contributing, you help make this project better and more accessible for others. Please take a moment to review the following guidelines to ensure a smooth and collaborative development process.
4+
5+
## Code of Conduct
6+
7+
Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to be respectful, considerate, and inclusive when interacting with the project and its community.
8+
9+
## How to Contribute
10+
11+
Here are the steps to contribute to this project:
12+
13+
1. Fork the Repository: Click the "Fork" button at the top right of this repository to create a copy in your GitHub account.
14+
15+
2. Clone the Repository: Clone your forked repository to your local machine using the following command:
16+
17+
```bash
18+
git clone https://github.com/nixrajput/bus-reservation-system-cpp.git
19+
```
20+
21+
3. Create a Branch: Create a new branch for your contributions. Make sure to choose a descriptive branch name that reflects the changes you intend to make.
22+
23+
```bash
24+
git checkout -b feature/your-feature-name
25+
```
26+
27+
4. Make Changes: Implement your changes and improvements in your local repository. Follow the coding style and best practices of the project.
28+
29+
5. Test Your Changes: Ensure that your changes do not introduce any errors or regressions. Test the website locally to verify that it functions as expected.
30+
31+
6. Commit Changes: Commit your changes with a clear and descriptive commit message.
32+
33+
```bash
34+
git commit -m "Add feature/fix: Describe your changes here"
35+
```
36+
37+
7. Push Changes: Push your changes to your forked repository on GitHub.
38+
39+
```bash
40+
git push origin feature/your-feature-name
41+
```
42+
43+
8. Create a Pull Request: Go to the original repository on GitHub and click the "New Pull Request" button. Provide a concise description of your changes, why they are necessary, and any relevant information.
44+
45+
9. Review and Collaboration: Contributors and maintainers will review your Pull Request. Be prepared to address any feedback or make additional changes as necessary.
46+
47+
10. Merge: Once your Pull Request is approved and passes all checks, a maintainer will merge it into the main branch. Congratulations, your contribution is now part of the project!
48+
49+
## Development Guidelines
50+
51+
- Follow the project's coding style and guidelines.
52+
- Write clear and concise code with comments where necessary.
53+
- Test your changes thoroughly before submitting a Pull Request.
54+
- Keep Pull Requests focused on a single feature or bug fix.
55+
- Be responsive to feedback and be willing to make improvements as requested.
56+
57+
## Reporting Issues
58+
59+
If you encounter any issues or bugs while using the Portfolio Website, please report them on the [Issues](https://github.com/nixrajput/bus-reservation-system-cpp/issues) page of the repository. Provide as much detail as possible to help us understand and address the problem.
60+
61+
## Thank You
62+
63+
Thank you for contributing to the Portfolio Website project. Your contributions help make this project better and more valuable to its users. We appreciate your time and effort in making this project a success!

0 commit comments

Comments
 (0)