Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

91 lines (63 loc) · 3.45 KB

Contributing

We want everyone to feel that they can contribute to the ARTIGENIUS-AI project of SDC-USAR. Whether you have an idea to share, a feature to add, an issue to report, or a pull-request of the finest code ever,which ever it may be, we want you to participate!

In the sections below, you'll find some easy way to connect with other developers as well as some useful informational links on our license and community policies.

Looking forward to building ARTIGENIUS-AI with you!

Github

The main project fork lives here in Github:

Setup Guide

  • After forking the website from the above link clone this repository to your local machine, Please use your username in place of {your_username}

    git clone https://github.com/{your_username}/ArtiGenius-AI.git

  • Change into the project directory:

    cd ArtiGenius-AI

  • Install project dependencies:

    pnpm install

  • Create a .env.local file in the project root and add your Hugging Face API key as NEXT_PUBLIC_HUGGINGFACE_API_KEY. You can get your API key from your Hugging Face account settings.

    NEXT_PUBLIC_HUGGINGFACE_API_KEY=your-api-key

  • Start the development server:

    pnpm run dev

Issues

If you spot a bug, then please feel free to raise an issue in our main GitHub project:

Resolving Issues

If you're new to the project and looking for a place to start, we recommend checking out the issues tagged with "good first issues". These issues are specifically curated for newcomers to the project, providing an opportunity to get familiar with the codebase and make meaningful contributions.

You can view the list of good first issues issues.

Points to remember while making contributions

  • Before working on any issues please make another branch with your username , to make one use the command 
    git branch {your_username}/your_branch
  • Then switch to that branch using the command 
    git checkout {your_username}/your_branch
  • Then follow the following commands to push your contributions on the github (please run one command at a time): 
    git add .
git commit -m "your message"
git push --set-upstream origin {your_username}/your_branch
  • The upstream command is required for the first time, after that you may simply use: 
    git push

Making Pull Requests

If you have developed a cool new feature or improvement, then send us a pull request. Please try and make sure that this is linked to an issue.

Please keep all pull requests on a separate branch with your username as told above!

  • To make a pull request please be in the repository that you got after forking the the original one and click on the Pull requests tab (present next to <>Code)

  • Then click New pull request and select the branch that you made earlier

  • Then click on Create pull request , give an appropriate title and in comments please mention the issue that you worked on.

  • Then click on Create pull request

License

  • This project is licensed under the MIT License - see the LICENSE file for details.