Skip to content

Latest commit

 

History

History
149 lines (95 loc) · 6.29 KB

CONTRIBUTING.md

File metadata and controls

149 lines (95 loc) · 6.29 KB
Raw

Contributing Guidelines

This documentation contains a set of guidelines to help you during the contribution process.

Creating New issues

  1. Go to the issues tab image
  2. Click on New Issue
  3. Add the title of the project/error/bug
  4. Write the description: The description should of the following or similar format:


# Project Name

## Project Description or About

## Tech Stack

## Final output
Jupyter file, website, app, python program etc.

## Submission
- [ ] Code reviewed
- [ ] Working demo
- [ ] Tasks completed

Submitting Contributions👩‍📈

Below you will find the process and workflow used to review and merge your changes.

  1. Find/Create an issue
  • Take a look at the Existing Issues or create your own Issues!
  • Wait for the Issue to be assigned to you after which you can start working on it.
  • Note : Every change in this project should/must have an associated issue.

  1. Fork the repository by clicking on the "Fork" button at the top right corner of the page.

  2. Once you are in your fork the url should look something like https://github.com/<YOUR-USERNAME>/GenAI-Projects/

  3. Go to preferred folder in your computer and paste the following command (Only one of it if you don't have ssh setup then go with HTTP command)

  • For HTTP
  git clone https://github.com/<YOUR-USERNAME>/GenAI-Projects.git
  • For SSH
  git clone [email protected]:<YOUR-USERNAME>/GenAI-Projects.git
  1. Now enter the folder by running the following command
cd GenAI-Projects

  1. Now you are in the GenAI-Projects folder

  2. Now go ahead and create a new branch, then switch to that branch.

git checkout -b fix-issue-<ISSUE-NUMBER>
  1. Create your project folder inside your selected domain (text-to-image or something else). Give it a Unique name.
for example- if you created a text-to-speech api then in that domain create your folder
Text-To-Speech/SpeechCreatorAPI

  1. Make your changes to the codebase. Test your changes to make sure they work as expected.

  2. After done you can now push this changes. for doing that follow the following command chain

    • git status (Shows the changed files)
    • git add . (Will add all the files to staging area)
    • git commit -m "feat/docs/fix: :emoji-name: <EXPLAIN-YOUR_CHANGES>"
    • git push origin fix-issue-<ISSUE-NUMBER>
  • NOTE: A PR should have only one commit. Multiple commits should be squashed.
  1. Create a Pull Request:
  • Go to your forked GitHub repository and navigate to the Pull Request section.
  • Click on the pop-up that says "Pull Request" to be redirected to the pull request page.
  • Fill in the form template of the pull request, adding a title and description that explain your contribution.
  • Include screenshots if they help clarify the enhancement/implementation/bug/documentation.
  • Click on Submit to create the pull request*

  1. Hurrey! You just did your contribution to this project 🎉

  2. Wait for your pull request to be reviewed and merged.

NOTE: Please make sure to follow the Code of conduct while contributing.

Alternatively, using GitHub Codespaces:

  1. Follow steps 1 to 3 above, to fork the repository.

  2. Navigate to the forked repository i.e. https://github.com/<YOUR-USERNAME>/Face-X/

  3. Click Code, then click Create codespace on master.

    image

  4. A new codespace will be created.

  5. Follow steps 6 to 9 above using the terminal in the codespace. Instead of step 9 you can also directly create a PR through codespace by going to the Source Control view in Activity Bar.

Alternatively, using GitHub Desktop:

  1. Open GitHub Desktop and log in to your GitHub account.

  2. Make sure you are on the "Current Repository" view. If not, go to "File" and select "Add Local Repository" to add your repository.

  3. In the "Current Repository" view, ensure you are on the branch that you want to submit a pull request for. If you're not on the correct branch, use the "Branch" menu to switch to the correct branch.

  4. Once you're on the correct branch, make your changes and commit them to the branch. You can do this by clicking the "+" button in the upper-left corner of the GitHub Desktop window, making your changes, and then entering a commit message.

  5. After you've made your changes and committed them, click the "Push origin" button in the top-right corner of the GitHub Desktop window. This will push your changes to the remote repository on GitHub.

  6. Now, go to the GitHub website, navigate to your fork of the repository, and you should see a button to "Compare & pull request" between your fork and the original repository, click on it.

  7. On the pull request page, you can review your changes and add any additional information, such as a title and a description, that you want to include with your pull request.

  8. Once you're satisfied with your pull request, click the "Create pull request" button to submit it.

Note: In order to create a pull request, you must have a fork of the original repository in your GitHub account and you must have made the changes in that forked repository.

Your Pull Request has been submitted and will be reviewed by the maintainer and merged.

Need more help?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:

Hope you will learn something new while contributing in this project!!🚀🚀