Commit17020d8

committed

doc(README): add basic contribution guidelines

The main point is that from now on, tests are required to addnew features. If the fix is minor enough, not having a testis probably alright.That distinction is not represented in the contribution guideas more tests are better - people should prefer to have a testwhenever they contribute anything.My motivation to finally do this is the sad realization thatI grow too unconfident about the quality of some contributionswithout having tests that proof they are valid. It's not enoughto not break anything that exists, as the current test-suite iscertainly not perfect either.

1 parent15ee5a5 commit17020d8Copy full SHA for 17020d8

File tree

2 files changed

-4

lines changed

2 files changed

-4

lines changed

`‎CONTRIBUTING.md`

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,6 @@`
	`1`	`+###How to contribute`
	`2`	`+`
	`3`	`+*[fork this project](https://github.com/gitpython-developers/GitPython/fork) on github`
	`4`	`+* Add yourself to AUTHORS.md and write your patch.Write a test that fails unless your patch is present.`
	`5`	`+* Initiate a pull request`
	`6`	`+`

`‎README.md`

Lines changed: 3 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -45,11 +45,9 @@ Then run:`
`45`	`45`
`46`	`46`	`tox`
`47`	`47`
`48`		`-###SOURCE`
	`48`	`+###Contributions`
`49`	`49`
`50`		`-GitPython's git repo is available on GitHub, which can be browsed at[github](https://github.com/gitpython-developers/GitPython) and cloned like that:`
`51`		`-`
`52`		`-git clone https://github.com/gitpython-developers/GitPython`
	`50`	`+Please have a look at the[contributions file][contributing].`
`53`	`51`
`54`	`52`	`###Live Coding`
`55`	`53`
`@@ -100,3 +98,4 @@ Now that there seems to be a massive user base, this should be motivation enough`
`100`	`98`
`101`	`99`	`[twitch-channel]:http://www.twitch.tv/byronimo/profile`
`102`	`100`	`[youtube-playlist]:https://www.youtube.com/playlist?list=PLMHbQxe1e9MnoEcLhn6Yhv5KAvpWkJbL0`
	`101`	`+[contributing]:https://github.com/gitpython-developers/GitPython/blob/master/README.md`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit17020d8

File tree

2 files changed

2 files changed

`‎CONTRIBUTING.md`

`‎README.md`

0 commit comments