Skip to main content

· 5 min read

About PaiNITTe​

PaiNITTe is an open-source website for all academic related activites for the students of NIT Trichy. You can find CTs and end semester question papers on this website. Click on Academic and Navigate to your department in the sidebar and select your year. Then you can find question papers under the respective subject name.

PaiNITTe is made using Docusauras 2, a modern static site generator.

About Docusaurus​

Docusaurus was first created and released to the public by the Facebook Open Source team in 2017. Since then, this project has been used by a large number of the Facebook open source projects and by over 100 external projects.

Docusaurus is a tool designed to make it easy for teams to publish documentation websites without having to worry about the infrastructure and design details. At its core, all a user has to provide are documentation files written in Markdown, customization of a provided home page written in React, and a few configuration modifications. Docusaurus handles the rest by providing default styles, site formatting, and simple document navigation.

It also provides core website and documentation features out-of-the-box including blog support, internationalization, search, and versioning.

To learn more about Docusaurus click the link here.

Contribution Guidelines​

What do I need to know to help 🤔?​

If you are looking to help to with a code contribution our project, look for tags which you like to work on. If you are beginner and want to do your first contribution check good first issue . If you don't feel ready to make a code contribution yet, no problem! You can also check out the documentation issues documentation or the design issues that we have design.

If you are interested in making a code contribution and would like to learn more about open source and the technologies that we use, check out the list below.

How do I make a contribution 😎?​

Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown!

Set-Up:​

  • Fork the repository associated with the issue to your local GitHub organization from https://github.com/TeCOS-NIT-Trichy/painitte. This means that you will have a copy of the repository under Your-GitHub-Username/painite.

  • Clone the repository to your local machine using git clone https://github.com/<YOUR_USERNAME>/painitte.git.

  • Now you will have a local repo of this project saved in your system.

  • Open the project in VS Code (or your preffered IDE).

  • Run npm install or npm i to install all the neccessary dependencies for the project.

  • Run npm start to run the project locally.

  • Now you can visit your local build at http://localhost:3000.

  • Create a new branch for your fix using the command git checkout -b branch-name-here.

  • Make the appropriate changes for the issue you are trying to address or the feature that you want to add.

Contributing the Project:​

You can make a contribution towards PainiTTe in either of the 2 ways mentioned below 👇.

Using Github:​

  1. Find an issue that you are interested in addressing or a feature that you would like to add.

  2. Use git add insert-paths-of-changed-files-here to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.

  3. Use git commit -m "Insert a short message of the changes made here" to store the contents of the index with a descriptive message.

  4. Push the changes to the remote repository using git push origin branch-name-here.

  5. Submit a pull request to the upstream repository.

  6. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".

  7. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!

  8. Wait for the pull request to be reviewed by a maintainer.

  9. Make changes to the pull request if the reviewing maintainer recommends them.

  10. Celebrate your success 🥳 after your pull request is merged!

Gforms:​

You can also contribute to PainiTTe website through Gforms 🤔. You just need to upload the questions papers or any resources (notes, pdf, images) in the Gform and we will add those question papers to the website✌️.

Gform link - https://forms.gle/eeM28bcrvYSvDRKn9

Where can I go for help 🤨?​

If you need help, you can ask questions on our whatsapp group.

What does the Code of Conduct ⚖️ mean for me ?​

Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.