Skip to content

CONTRIBUTORS GUIDE

Jump to bottom
DS-AI-GATE edited this page Sep 7, 2023 · 2 revisions

DSAI-GATE Contributor's Guide

Thank you for considering contributing to the DSAI-GATE project! Whether you are a seasoned programmer or just getting started, your contributions are valuable. This guide will walk you through the process of contributing code and markdown to the project.

Contributing Code

  1. Fork the Repository: Start by forking the DSAI-GATE repository to your own GitHub account. You can do this by clicking the "Fork" button on the top right of the repository page.

  2. Clone the Repository: Use git to clone your forked repository to your local machine. Replace [your-username] with your GitHub username.

    git clone https://github.com/[your-username]/dsai-gate.git

  3. Create a New Branch: Create a new branch for your work. Give it a descriptive name related to the feature or bug you're addressing.

    git checkout -b feature/your-feature-name

  4. Make Changes: Make your desired changes to the codebase. Ensure your code follows the project's coding style and conventions.

  5. Commit Changes: Commit your changes with a clear and concise commit message.

    git commit -m "Add feature: your feature name"

  6. Push Changes: Push your changes to your GitHub repository.

    git push origin feature/your-feature-name

  7. Create a Pull Request: Go to the original DSAI-GATE repository on GitHub and create a pull request (PR) from your branch. Describe the changes you made in the PR description. Be sure to reference any related issues if applicable.

  8. Review and Collaboration: Collaborate with other contributors and address any feedback or comments on your PR. Once your changes are approved, they will be merged into the main project.

Contributing Markdown

  1. Fork the Repository: If you haven't already, follow the same forking process as described in the code contribution section.

  2. Clone the Repository: Clone your forked repository to your local machine as mentioned before.

  3. Create a New Branch: Just like with code contributions, create a new branch for your markdown work.

  4. Edit Markdown Files: Edit the markdown files within the repository. Markdown is a lightweight markup language, so you don't need any special tools to edit it. You can use a plain text editor.

  5. Commit Changes: Commit your changes with a clear commit message.

  6. Push Changes: Push your changes to your GitHub repository.

  7. Create a Pull Request: Go to the original DSAI-GATE repository on GitHub and create a pull request from your branch. Describe the changes you made in the PR description. Be sure to reference any related issues if applicable.

  8. Review and Collaboration: Collaborate with other contributors and address any feedback or comments on your PR. Once your changes are approved, they will be merged into the main project.

Creating Contributions towards Markdown

Markdown is a versatile format for documenting your contributions. Here are some tips for creating markdown content:

  • Use a consistent and readable style for headings, lists, and code snippets.
  • Make use of formatting options like bold, italic, and code for clarity.
  • Include relevant images or diagrams to illustrate your points.
  • Use links to reference external sources or related content within the repository.
  • Ensure your markdown is well-structured and easy to follow.

By following this guide, you can contribute effectively to the DSAI-GATE project, whether it's by improving the codebase or enhancing the documentation. Your contributions help make the project more valuable to the community. Thank you for your dedication and support!

Clone this wiki locally