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

#10 README.md: Created a README.md file #22

Closed
wants to merge 8 commits into from

Conversation

m4tr1k
Copy link
Contributor

@m4tr1k m4tr1k commented Dec 4, 2017

The file now has all the things issue #10 asked.

Fixes #10

The file now has all the things issue coala#10 asked.

Fixes <coala#10>
Copy link
Member

@prnvdixit prnvdixit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few commit changes - Your Shortlog should be imperative "Created" -> "Create". Also, use "Closes" instead of "Fixes" as the issue is not labelled "bug". 😃
No need of <...> in issue reference 😉
Also, I am not so sure about using ';' either.... 👍

README.md Outdated
@@ -1 +1,8 @@
# community
Coala Community
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"coala" is always written with small "c". 😉

README.md Outdated
Coala Community

### Features
* It is a static django website;
Copy link
Member

@prnvdixit prnvdixit Dec 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe replace "it" with "This repository"?

@prnvdixit
Copy link
Member

Also, it's not mandatory to add a commit description - You can omit it if you feel like it, it's not needed here.

@prnvdixit
Copy link
Member

prnvdixit commented Dec 4, 2017

Maybe omit coala Community altogether. Though I am not sure, let someone else take a look too 😄.

Also, I meant keeping ## Features as it is, just use "This repository" instead of "it" for the first line. Meanwhile, you can take a look at other READMEs in the coala repos, and take clues from them.

Also, please squash your commits together. 👍

Francisco Fernandes added 6 commits December 4, 2017 18:14
Closes coala#10

README.md: Create a README.md file

Closes coala#10

README.md: Created a README.md file

The file now has all the things issue coala#10 asked.

Fixes <coala#10>
# The first commit's message is:

Merge branch 'my-first-good-pull-request' of https://github.com/m4tr1k/community into my-first-good-pull-request

# This is the commit message coala#2:

README.md: Create a README.md file

Closes coala#10
@m4tr1k m4tr1k closed this Dec 4, 2017
@m4tr1k m4tr1k deleted the my-first-good-pull-request branch December 4, 2017 23:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

4 participants