Skip to content

Commit 5fe78e2

Browse files
Initial commit v0.0.1
Signed-off-by: Jacob Stopak <jacob@initialcommit.io>
0 parents  commit 5fe78e2

File tree

9 files changed

+641
-0
lines changed

9 files changed

+641
-0
lines changed

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.DS_Store
2+
__pycache__
3+
*.pyc
4+
build/
5+
dist/
6+
git_dummy.egg-info/

CONTRIBUTING.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# Contributing to Git-Dummy
2+
3+
Thanks for checking out Git-Dummy and for your interest in contributing!
4+
5+
## Reporting bugs
6+
7+
To report a bug you found, please open a [GitHub issue](https://github.com/initialcommit-com/git-dummy/issues/new)
8+
and describe the error or problem in detail. Please check [existing issues](https://github.com/initialcommit-com/git-dummy/issues)
9+
to make sure it hasn't already been reported.
10+
11+
When submitting a new issue, it helps to include:
12+
13+
1) The steps you took that lead to the issue
14+
2) Any error message(s) that you received
15+
3) A description of any unexpected behavior
16+
4) The version of Git-Dummy you're running
17+
5) The version of Python you're running and whether it's system-level or in a virtual environment
18+
6) The operating system and version you're running
19+
20+
## Suggesting enhancements or new features
21+
22+
If you've got a cool idea for a feature that you'd like to see implemented in
23+
Git-Dummy, we'd love to hear about it!
24+
25+
To suggest an enhancement or new feature, please open a [GitHub issue](https://github.com/initialcommit-com/git-dummy/issues/new)
26+
and describe your proposed idea in detail. Please include why you think this
27+
idea would be beneficial to the Git-Dummy user base.
28+
29+
## Your first code contribution
30+
31+
Note: Git-Dummy is a new project so these steps are not fully optimized yet, but
32+
they should get you going.
33+
34+
To start contributing code to Git-Dummy, you'll need to perform the following
35+
steps:
36+
37+
1) [Fork the Git-Dummy codebase](https://github.com/initialcommit-com/git-dummy/fork)
38+
so that you have a copy on GitHub that you can clone and work with
39+
2) Clone the codebase down to your local machine
40+
3) If you previously installed Git-Dummy normally using pip, uninstall it first using:
41+
42+
```console
43+
$ pip uninstall git-dummy
44+
```
45+
46+
4) To run the code locally from source, install the developement package by running:
47+
48+
```console
49+
$ cd path/to/git-dummy
50+
$ python -m pip install -e .
51+
```
52+
53+
This will install sources from your cloned repo such that you can edit the source and the changes are reflected instantly.
54+
55+
If you already have the dependencies, you can ignore those using the `--no-deps` flag:
56+
57+
```console
58+
$ python -m pip install --no-deps -e .
59+
```
60+
61+
5) You can run Git-Dummy commands locally like this:
62+
63+
```console
64+
$ git-dummy [global options] <subcommand> [subcommand options]
65+
```
66+
67+
5) After pushing your code changes up to your fork, [submit a pull request](https://github.com/initialcommit-com/git-dummy/compare) for me
68+
to review your code, provide feedback, and integrate it into the codebase!
69+
70+
## Code style guide
71+
72+
Since Git-Dummy is a new project, we don't have an official code style set in
73+
stone. For now just try and make your new code fit in with the existing style
74+
you find in the codebase, and we'll update this section later if that changes.
75+
76+
## Code Formatting
77+
78+
This project uses the [`black`](https://github.com/psf/black) code formatter to keep all code in a constistent format.
79+
80+
Please install it in your development environment and run `black path/to/changed/files` before committing any changes.
81+
82+
## Commit conventions
83+
84+
We have a few simple rules for Git-Dummy commit messages:
85+
86+
1) Write commit messages in the [imperative mood](https://initialcommit.com/blog/Git-Commit-Message-Imperative-Mood)
87+
2) Add a signoff trailer to your commits by using the `-s` flag when you make
88+
your commits, like this:
89+
90+
```
91+
$ git commit -sm "Fixed xyz..."
92+
```
93+
94+
## Questions
95+
96+
If you have any additional questions about contributing to Git-Dummy, feel free
97+
to [send me an email at jacob@initialcommit.io](mailto:jacob@initialcommit.io).

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Initial Commit LLC
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)