Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add contribution instructions #728

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

ckhatton
Copy link
Member

@ckhatton ckhatton commented Feb 26, 2017

I would like to add instructions on how to contribute to the project. I was going create an 'issue' to ask if this branching practice could be used from now on (or if one is being used), but I thought I would just go ahead an create it. I don't mind if the idea is rejected, as I was going to write similar instructions for my own repos.

It also details how to version number.

If you agree to accept this pull request, then please merge it to a branch named 'develop' using the --no-ff flag, which follows the new guidelines set out in CONTRIBUTE.md 馃槂

You could increase my level of access, so I can just do it myself 馃槈

@mde
Copy link
Contributor

mde commented Feb 28, 2017

Definite plus one for adding contributing instructions. However, there is some overlap between this and the Contributing page on the wiki (https://github.com/geddy/geddy/wiki/Contributing-to-Geddy). We should probably pick one or the other, or maybe have a summary in the file, and link to the wiki for more details.

The release strategy you describe in the file is not the same as what we were previously using. There's a brief description of it in the wiki page -- basically development happens on master, and release branches for major versions (e.g., v13) are spun off of that. (Those are effectively versioned production branches.)

Bugfixes for the release branch are done against the release branch, and then cherry-picked back into master.

@mde
Copy link
Contributor

mde commented Mar 18, 2017

The Geddy codebase is not that huge. I don't know if I'd characterize it as "excessive." Having a note about maintenance-mode might be fine, but "stale" seems a little harsh. :)

@ckhatton ckhatton changed the title Add contribution instructions Feature: Add contribution instructions Nov 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants