Skip to content

Latest commit

 

History

History
112 lines (64 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

112 lines (64 loc) · 2.76 KB
Raw

Contribution Guidelines

We would love for you to contribute to this project. As a contributor, here are the guidelines we would like you to follow:

Be Kind - Code of Conduct

Please read and follow our Code of Conduct to help us keep this project open and inclusive.


Found a bug? Want a feature? - Submit an Issue

Choose an issue template to file a bug report / feature request.


Ready to contribute a Pull Request (PR)?


▶ 1. First - Search this repo for existing PRs

Try to find an open or closed PR that relates to the change you want to introduce.


▶ 2. Before you start coding - find / create an issue

Make sure there's an issue describing the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design up front helps to ensure that we're ready to accept your work.

Don't waste your time working on code before you got a 👍 in an issue comment.


▶ 3. Fork the this repo and create a branch

  • Hit the "Fork" button above this GitHub repository

  • git clone YOUR_FORK_URL

  • Create a new branch locally in your fork's repo

  • git checkout -b my-fix-branch master


▶ 4. Run the development server

  • From the root of the project run yarn install.

  • Then, in one terminal run yarn dev


▶ 5. Push your branch to GitHub

git push origin my-fix-branch

▶ 6. Create a PR

In GitHub, create a pull request for flaviodelgrosso/chatgpt-desktop-app-tauri:master

Make sure you check the checkbox "Allow edits from maintainers"

If you need to update your PR for some reason -

  • Make the required updates.

  • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

    git rebase master -i
git push -f

▶ 7. After your PR is merged - delete your branches

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Thanks for your contribution! 🙏