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

updating how_to_contribute.md and removing version control chapter. #521

Merged
merged 2 commits into from
Oct 21, 2018

Conversation

leios
Copy link
Member

@leios leios commented Oct 19, 2018

This removes the version control chapter and modifies the How to Contribute chapter with links to the guides and resources provided.

As a note, because the code style guide is incomplete, I left that note as it was before.

Also note that this will be updated soon when we finally figure out #493 and work more on #388

@june128 june128 added Hacktoberfest The label for all Hacktoberfest related things! Chapter Edit This changes the archive's chapters. (md files are edited.) General labels Oct 20, 2018
@june128 june128 self-assigned this Oct 20, 2018
Currently, we are not accepting chapter submissions; however, we will allow for this in the near future.
For now, here are the basics for submitting code to the Algorithm Archive:

1. **Style**: Follow standard style guidelines associated with your language of choice. For C / C++, please use Stroustrup style, with `auto` used rarely or not at all. We have had plenty of discussions about this, which can be found [here](https://github.com/algorithm-archivists/algorithm-archive/issues/18). Basically, your code should be readable and understandable to anyone -- especially those who are new to the language. In addition, remember that your code will be displayed in this book, so try to keep to around 80 columns and try to remove any visual clutter. In addition, keep variable names clean and understandable.
Copy link
Member

Choose a reason for hiding this comment

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

This can be updated to include link to wiki code style section and extend that guide with c/c++ and julia rules.

@leios leios merged commit e089746 into algorithm-archivists:master Oct 21, 2018
@leios leios deleted the how_to_contribute_update branch October 22, 2018 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Chapter Edit This changes the archive's chapters. (md files are edited.) General Hacktoberfest The label for all Hacktoberfest related things!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants