Before you submit your issue search the archive, maybe your question was already answered. If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. The "new issue" form contains a number of prompts that you should fill out to make it easier to understand and categorize the issue. In general, providing the following information will increase the chances of your issue being dealt with quickly: Overview of the Issue - if an error is being thrown a non-minified stack trace helps Motivation for or Use Case - explain why this is a bug for you Application Version(s) - is it a regression? Reproduce the Error - provide an example (using a screen recorder) or an unambiguous set of steps. Related Issues - has a similar issue been reported before? Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit) If you get help, help others. Collect good karma.
- Create the development environment
- Make your changes in a new git branch:
git checkout -b my-fix-branch master - Create your patch commit, including appropriate test cases.
- Run the tests, and ensure that they pass.
- Commit your changes using a descriptive commit message.
git commit -aNote: the optional commit -a command line option will automatically "add" and "rm" edited files. - Before creating the Pull Request, run all tests for a last time.
Push your branch to GitHub:
git push origin my-fix-branch
- In GitHub, send a pull request to
sharadv245/Memory-Assistant/new/master. - If we suggest changes, then:
- Make the required updates.
- Commit your changes to your branch (e.g. my-fix-branch).
- Push the changes to your GitHub repository (this will update your Pull Request). You can also amend the initial commits and force push them to the branch.
This is generally easier to follow, but seperate commits are useful if the Pull Request contains iterations that might be interesting to see side-by-side. That's it! Thank you for your contribution!git rebase master -i git push origin my-fix-branch -f
After your pull request is merged 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
- Feel free to join the Slack workspace
- eMail address – memoryassistantapp@gmail.com