Theory

Contribution Guidelines

Welcome to the HPTU Exam Helper content contribution section. The content of the site is written in markdown, a lightweight markup language with plain-text formatting syntax. It is simple to learn and use, allowing contributors to focus on writing content without needing to understand complex formatting rules. Markdown supports a wide range of formatting options, including headings, lists, links, images, and code blocks, providing the flexibility needed to create rich, structured content. It also integrates seamlessly with GitHub, which is our chosen platform for managing and reviewing contributions. This makes it easy for contributors to submit their articles and for us to manage them.

You can contribute by writing articles on topics from your syllabus:

1. Choose a Topic - Select a topic from your syllabus in any subject.

2. Write Your Article - Prepare a well-structured article covering the chosen topic. Ensure clarity, depth, and relevance. Make sure you don’t just copy and paste articles from other sites or PDFs. You should modify the article.

3. Submit Your Article - We will review your article and provide feedback or approve it for publication.

How to Contribute?

There are two ways:

  1. Changing an existing article on the site
  2. Writing a new article

Changing an Existing Article on the Site

Open GitHub

  1. Click on the button present in the bottom right of each page.

    Article

  1. Click on the Continue to Github button.
Continue img

  1. Create a GitHub account (if you don't have one).
GitHub img

After that, you will be redirected to the page shown below.

Fork the Repository

  1. Fork the GitHub repository by clicking on the Fork this repository button.

    Fork img

  1. You can start writing your article using md syntax and preview your code using the Preview button.
Write img

  1. After writing your article, click on the Commit changes... button.
Commit Changes img

  1. Write a description of your changes in the title and click on the Propose changes button.
Changes img

  1. After that, click on the Create pull request button.
Changes Button img

Another img

  1. Upon review, your pull request can be labeled as improve content or accepted.

    • accepted - If your pull request is labeled as accepted, congratulations! Your article has been approved and will be published on the site :)
    • improve content - If your pull request is labeled as improve content, additional instructions will be provided detailing what changes are needed. You might need to edit your article.

You will receive an email regarding the status of your pull request.

Edit Article

  1. To edit your submitted article, go to the site pulls page, find your pull request, and click on your forked repository.

    Edit img

  2. Find the article you have modified. Here, I have modified the article for Semester III -> Java Programming -> Unit I -> An Overview of Java.

    Edit img

  3. Click on the edit icon, modify your article, and repeat steps from Fork the Repository step 3 and 4.

    Edit Again img

Writing a New Article

Open GitHub

  1. Go to the HPTU Exam Helper repository.

  2. Click on Add file -> Create new file button.

    Add File img

Fork the Repository

  1. Fork the GitHub repository by clicking on the Fork this repository button.

    Fork img

  2. Name your file based on the topic of the title, ensuring it ends with the .md extension. At the top of the article, make sure to mention the Semester -> Subject Name -> Unit.

    New File img

  3. The rest of the steps are the same as Fork the Repository step 3 onwards.

md Syntax


Link syntax []() can also be used to link to a YouTube video.

For example,

[MD Syntax](https://www.youtube.com/watch?v=dHIBYItuF2I) will render as: MD Syntax

Next

BTech CSE Semester I

Page Contents

Contribution Guidelines
How to Contribute?
Changing an Existing Article on the Site
Open GitHub
Fork the Repository
Edit Article
Writing a New Article
Open GitHub
Fork the Repository
md Syntax