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

Add code style page #36

Closed
wants to merge 1 commit into from
Closed

Add code style page #36

wants to merge 1 commit into from

Conversation

tarruda
Copy link
Member

@tarruda tarruda commented Mar 28, 2014

This is the code style, I guess we should host it into the website.

Not sure if we should put a link to it in the main page though, perhaps linking from the wiki is more appropriate. What do you guys think?

@cweagans
Copy link
Contributor

How was this generated? Was it using some tool or something?

I'm generally -1 to putting highly technical things like this on the website until we have more of a community site. As it is right now, it's more of a brochure site and I think we should keep it very simple.

This style guide seems better to go in the Neovim wiki, and then link to it from the Readme file in the main neovim repo.

@tarruda
Copy link
Member Author

tarruda commented Mar 28, 2014

Ok I will create a repo for the style guide and host it there

@tarruda tarruda closed this Mar 28, 2014
@lslah lslah mentioned this pull request Mar 28, 2014
@jszakmeister
Copy link

FWIW, I think the main website is the right place--what better way to start a community site than by trying to get it in place? It'd be nice if it could be easily translated and put on the wiki, but I don't think it can. if it helps, the style guide was derived from Google's C++ Style Guide: https://code.google.com/p/google-styleguide/

And no, it's not generated. :-(

@cweagans
Copy link
Contributor

I think the website is the right place too, just not right now. Right now, it's a very simple site, and I think we should keep it that way as long as possible.

My main hangup on this is that right now, it's a one page site describing the mission of the project and how to get involved. Something very technical like this doesn't belong on the main site. I'm not opposed to setting up a separate subsite for developer information, but we need to plan what's going to be there and not just toss random things into it.

@jszakmeister
Copy link

I think the website is the right place too, just not right now.

Something very technical like this doesn't belong on the main site.

That seems contradictory to me, but I think what you're saying here is that there should be a developer.neovim.org or community.neovim.org site. I guess I don't know what advantage there is to separating it that way, but I'm not too concerned about it--I'm sure it's in good hands. :-)

Personally, I think a "Get Involved" section would:

  • Point to the IRC channel and mailing list
  • A link to the main GitHub site
  • A link to the issue tracker, along with some guidelines about submitting bug reports
  • The style guide
  • License information
  • Maybe the Doxygen API
  • And, perhaps a developer code of conduct?

Anyways, that was just some of my thoughts. :-)

@tarruda
Copy link
Member Author

tarruda commented Mar 31, 2014

@jdavis I've create a new-repository and pulled the code style commits from your mirror. I've also added you to the development-wiki to the team since you already had the initiative of forking the style guide(I hope that's ok)

The style can be found here

@jdavis
Copy link
Contributor

jdavis commented Mar 31, 2014

@tarruda Yup, that's fine by me! =D

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.

4 participants