Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 3.37 KB

README.md

File metadata and controls

92 lines (63 loc) · 3.37 KB
Raw

The Official Website of TASC AIML

Welcome to the official repository of TASC website! We're glad you're interested in our repository. Please take a moment to read through these guidelines before you get started.

Table of Contents

Getting Started

Prerequisites

Before you start contributing, ensure that you have the following prerequisites installed:

Installation

  1. Fork this repository by clicking the 'Fork' button on the top right corner of this page.

  2. Clone your forked repository to your local machine.

  3. Navigate to the project directory

  4. Install the project dependencies

    npm install

  5. Start the development server

    npm run dev

Now you're ready to start contributing!

Contributing

We welcome contributions from the community. Whether it's fixing a bug, adding a feature, or improving documentation, your help is greatly appreciated.

Reporting Issues

If you encounter any issues while using our website, please create a new issue in our GitHub repository. Be sure to provide as much detail as possible to help us understand and reproduce the problem.

Making Changes

  1. Create a new branch for your feature or bug fix.
  2. Make your changes and commit them to your local repository.
  3. Push your changes to your forked repository.
  4. Create a Pull Request

Pull Requests

Please open an issue first to discuss what you would like to change. When you're ready to submit your changes, open a pull request and please mention the particular issue(s) in the description:

  1. Go to the Pull Requests tab of your forked repository on GitHub.
  2. Click the "New Pull Request" button.
  3. Set the base repository to our committee's official repository.
  4. Ensure the branch you want to merge is selected, and write a descriptive title and message explaining your changes.

    Note we don't accept PRs to the main branch

  5. Click the "Create Pull Request" button.

Our team will review your pull request and provide feedback. Thank you for your contribution!

Coding Guidelines

We follow the following conventions for commit messages:

  • feat: The new feature you're adding to a particular application
  • fix: A bug fix
  • style: Feature and updates related to styling
  • refactor: Refactoring a specific section of the codebase
  • test: Everything related to testing
  • docs: Everything related to documentation
  • content/assets: Add static content
  • chore: Regular code maintenance

Please follow our coding guidelines and best practices when making changes to the codebase.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for considering contributing to our committee's website! Your help makes a difference.