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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[README] Proposal for a more informative README.md #36

Merged
merged 1 commit into from Oct 31, 2018

Conversation

jgbarah
Copy link
Collaborator

@jgbarah jgbarah commented Oct 31, 2018

I've tried to put together all the issues that we commented during our last meeting, on how to contribute, when we meet, how we're structured, the usual process to propose changes, etc. I propose this just as a first step, further pull requests could refine everything in this file.

For some file/directory names I'm proposing another pull request, simplifying their names (I'm already using the "new" names here).

I've tried to put together all the issues that we commented during our last meeting, on how to contribute, when we meet, how we're structured, the usual process to propose changes, etc. I propose this just as a first step, further pull requests could refine everything in this file.

For some file/directory names I'm proposing another pull request, simplifying their names (I'm already using the "new" names here).
@klumb
Copy link
Member

klumb commented Oct 31, 2018

I think this reads well and describes the process clearly. There are some minor typos but other wise good. I am not sure how to share those here. I would be happy to edit the document.

I like the issue requirement. Due to the nature of the work, I think it is important to explicitly link pull requests to issues.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@sgoggins sgoggins merged commit d8df0b2 into master Oct 31, 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

3 participants