Skip to content
This repository was archived by the owner on Jun 10, 2022. It is now read-only.

Commit c654d1e

Browse files
authored
add contributing
1 parent 40fd461 commit c654d1e

File tree

1 file changed

+11
-73
lines changed

1 file changed

+11
-73
lines changed

README.md

+11-73
Original file line numberDiff line numberDiff line change
@@ -14,86 +14,24 @@ An Atom.io package to use git from the context menu. You can choose which comman
1414

1515
This package will add a "Git" item to the context menu when you right click on the tree-view, tabs, or the editor.
1616

17-
## Commands
17+
## Documentation
1818

19-
### Commit...
19+
[See /docs/docs.md](https://github.com/UziTech/context-git/blob/master/docs/docs.md)
2020

21-
You can commit a single file or multiple files or folders selected in the tree-view. This command will bring up a dialog window where you can deselect any files you do not want to commit.
21+
## Contributing
2222

23-
You can also choose to amend the last commit with the selected files and/or optionally change the last commit message.
23+
### Voting
2424

25-
You then have the following options to commit the message/files:
25+
The easiest way to contribute to this package is to vote on new commmands. New commands are entered as issues with the [`command`](https://github.com/UziTech/context-git/issues?q=is%3Aissue+is%3Aopen+label%3Acommand) label. I will prioritize commands with the most :+1:'s
2626

27-
- "Commit" will just commit the files.
28-
- "Commit & Push" will commit the files then push them to origin.
29-
- "Commit & Pull & Push" will commit the files, pull from origin then push to origin.
27+
### Submit Commands
3028

31-
### Commit All...
29+
If there are commands you would like to see just create an issue with the command template and I will label it as a command.
3230

33-
Same as [Commit...](#commit) but will list all changed files in the dialog
31+
### Submit An Issue
3432

35-
### Discard Changes
33+
If you find a bug or just have a question about something create an issue and I will be happy to help you out.
3634

37-
This will discard changes to the selected files.
35+
### Create A Pull Request
3836

39-
### Discard All Changes
40-
41-
This will discard changes to the all files in the repo.
42-
43-
### Add To Last Commit
44-
45-
This will add the selected files to the last commit.
46-
47-
If you want to change the message of the last commit you will have to choose [Commit...](#commit) or [CommitAll...](#commit-all)
48-
49-
### Undo Last Commit
50-
51-
This will undo the last commit but save the changes. Like `git reset --mixed HEAD~1`
52-
53-
### Switch Branch
54-
55-
Checkout a different branch in this repo.
56-
57-
### Create Branch
58-
59-
Create a branch and optionally track/create a remote branch.
60-
61-
### Ignore Changes
62-
63-
Update the index with the changed version but don't commit the changes. Like `git update-index --assume-unchanged`
64-
65-
### Unignore Changes
66-
67-
Opposite of [Ignore Changes](#ignore-changes). Like `git update-index --no-assume-unchanged`
68-
69-
### Pull
70-
71-
Pull from tracked upstream
72-
73-
### Push
74-
75-
Push to tracked upstream
76-
77-
### Pull & Push
78-
79-
Pull then Push
80-
81-
### Initialize
82-
83-
Initialize a git repo for the current project.
84-
85-
### Refresh
86-
87-
Refresh the git status in Atom.
88-
89-
### Fetch
90-
91-
Fetch from all tracked repos
92-
93-
### Stash Changes
94-
95-
Save changes and checkout last commit
96-
97-
### Unstash Changes
98-
99-
Restore changes from last stash
37+
If there is an issue you think you can fix or a command you think you can implement just create a pull request referencing that issue so I know that you are working on it

0 commit comments

Comments
 (0)