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.

Sign up for GitHub

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

Jump to bottom

Add changelog & contributing docs #32

Open
sum01 opened this issue Oct 10, 2017 · 2 comments
Open

Add changelog & contributing docs #32

sum01 opened this issue Oct 10, 2017 · 2 comments
Labels
documentation low priority

Comments

@sum01
Copy link
Contributor

sum01 commented Oct 10, 2017 •
edited
Loading

We should consider making a CHANGELOG.md and CONTRIBUTING.md. The changelog should be easy, as we can fill it will all the news posts from the site. I might push that myself sometime soon.

The contributing.md should have stylistic standards for everyone who submits code to go by, such as using XYZ beautifier, with X spaces (or tabs, whatever), and explain the preferred git workflow. @xCoreDev might need to make some of those decisions, since he's done the majority of the C++ stuff.

But if it's up to vote, mine goes to the uncrustify beautifier, and tabs with tabsize 2 😄
@sum01
Copy link
Contributor Author

sum01 commented Oct 10, 2017

http://keepachangelog.com has good guidelines on changelogs.
https://github.com/blog/1184-contributing-guidelines has examples of a contributing file.

@sum01 sum01 mentioned this issue Oct 11, 2017
Open
@cryptokat
Copy link

beautifier

How about creating an .editorconfig file? Editorconfig is cross-platform and cross-editor.
http://editorconfig.org/
https://gist.github.com/buoto/7e2cff6c17c108658fc751df845b1040

sum01 added a commit to sum01/vcash that referenced this issue Feb 6, 2018
@sum01
Add an editorconfig
6c39a73 
Just set to the style already used in the code, 4 spaces.
Ref openvcash#32

I left remove trailing whitespace commented out since there's an insane ammount of trailing whitespace in the source code.
Any small edits were causing big diffs that removed the whitespace.

TODO: uncomment and remove all trailing whitespace across the codebase.
sum01 added a commit to sum01/vcash that referenced this issue Feb 6, 2018
@sum01
Add an editorconfig
b7eefde 
Just set to the style already used in the code, 4 spaces.
Ref openvcash#32

I left remove trailing whitespace commented out since there's an insane ammount of trailing whitespace in the source code.
Any small edits were causing big diffs that removed the whitespace.

TODO: uncomment and remove all trailing whitespace across the codebase.
sum01 added a commit that referenced this issue Feb 6, 2018
@sum01
Add an editorconfig
8b19d87 
Just set to the style already used in the code, 4 spaces.
Ref #32

I left remove trailing whitespace commented out since there's an insane ammount of trailing whitespace in the source code.
Any small edits were causing big diffs that removed the whitespace.

TODO: uncomment and remove all trailing whitespace across the codebase.
sum01 added a commit that referenced this issue Feb 7, 2018
@sum01
Add an editorconfig
66db0b0 
Just set to the style already used in the code, 4 spaces.
Ref #32

I left remove trailing whitespace commented out since there's an insane ammount of trailing whitespace in the source code.
Any small edits were causing big diffs that removed the whitespace.

TODO: uncomment and remove all trailing whitespace across the codebase.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation low priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sum01 @cryptokat