thecrusader25225 / supnits-classes

It is a generalised website for an educational institute comprising of different articles, sections, courses, mentors and testimonials provided by the institute. It can be used for multiple purposes by changing the fields as and when required.

Supnits-Classes Contribution Guidelines

Welcome to the Supnits-Classes repository! We appreciate your interest in contributing to our educational institute's website. Whether you're a developer, designer, or content creator, your contributions are valuable in enhancing the overall quality of our platform.

Table of Contents

• Getting Started
  • Fork the Repository
  • Clone the Repository
• Contribution Workflow
  • Branching
  • Making Changes
  • Committing
  • Creating a Pull Request
• Issues and Bugs
• Community and Communication

Getting Started

Fork the Repository

To contribute, start by forking this repository. Click the "Fork" button at the top right corner of this page. This creates a copy of the repository in your GitHub account.

Clone the Repository

Clone your forked repository to your local machine. Replace <username> with your GitHub username.

git clone https://github.com/<username>/Supnits-Classes.git

Now, you are ready to make your contributions.

How to Run this project locally

1. Navigate to the cloned repository in your local system.

  cd <Project folder name>

2. Install dependencies

  npm install

3. Run the Application

  npm start

Contribution Workflow

Branching

Create a new branch for your work. Choose a descriptive branch name related to the feature or fix you're working on.

git checkout -b feature/your-feature-name

Making Changes

Make your changes in the local repository. Ensure that your contributions align with the project's goals and guidelines.

Committing

Commit your changes with clear and concise commit messages. Reference any relevant issue numbers in your commits.

git add .
git commit -m "Your descriptive commit message closes #123"

Creating a Pull Request

Push your changes to your forked repository, and then create a pull request from there. Provide a clear title and description of your changes. Mention the related issue numbers in the pull request description.

We will review your contribution, provide feedback, and merge it if everything looks good.

Contributors ✨

Thanks goes to these wonderful people 💜

Anushka Bhowmick 🚧✍️🖥️

Souvik 💻

Debaditya Som 💻

Soumojit Shome 💻

Vineeth P V 💻

ASHISH GUPTA 💻

Anit Sarkar 💻

madhurima316 💻

Rajdeep Chowdhury 💻

Satwick Mukherjee 💻

Indrani Som 💻

Arghadip Manna 💻

Issues and Bugs

If you encounter any issues or bugs, please open an issue on the repository. Provide detailed information about the problem, steps to reproduce, and any relevant screenshots.

Community and Communication

Follow these points during your contribution. We appreciate open and respectful communication.

• Always open an issue before contributing to the repository.
• Get yourself assigned before starting to work on an issue. Check if someone is already assigned for it.
• If there is inactivity from your side for quite some time, someone else will be given the chance.
• Be respectful towards the community.
• Mention the issue number on your PR.

Thank you for contributing to Supnits-Classes! ❤️