Skip to content

Chapter Submission

Jump to bottom
James Schloss edited this page Jan 3, 2019 · 11 revisions

If you wish to submit a new chapter to the Algorithm Archive, please contact James Schloss (Leios) to ensure that:

  1. The chapter fits into the broader scope of the Algorithm Archive
  2. There is enough material available to write the chapter
  3. The chapter is not already in the process of being written

Chapter submissions are still a relatively new concept for the Algorithm Archive, so the review process might be a bit strict. If you have any questions or want to contact us, please feel free to go to Discord.

Licensing

The text of the Algorithm Archive is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA); however, the figures and images can be licensed under any other compatible license, such as Public Domain (CC0) or the Creative Commons Attribution license (CC BY.

To indicate the licensing of the provided chapter, please modify the following license indication and place it at the end of your chapter:


## License

##### Code Examples

The code examples are licensed under the MIT license (found in [LICENSE.md](https://github.com/algorithm-archivists/algorithm-archive/blob/master/LICENSE.md)).

##### Text

The text of this chapter was written by [NAME](https://github.com/NAME) and is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/legalcode).

[<p><img  class="center" src="../cc/CC-BY-SA_icon.svg" /></p>](https://creativecommons.org/licenses/by-sa/4.0/)

##### Images/Graphics
- The image "[example Image](res/example.png)" was created by [NAME](https://github.com/NAME) and is licenced under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/legalcode).

##### Pull Requests

The following pull requests have modified the text or graphics of this chapter:
- PR NUMBER

This text can be found in contents/cc/license.txt.

If there is anyone who has majorly modified the contents of the text during the review process, please discuss attributing them in the license notification too.

Chapter contents

Each chapter is expected to be a complete description of an algorithm, data structure, or method. As such, the text alone should be sufficient for readers to understand and write the algorithm for the first time. It is expected that all code written for the chapter conforms to the style appropriate for your language of choice (as indicated in the Code Style Guide. Each chapter will be reviewed based on 4 guiding criteria (in no particular order):

  1. Does the chapter fit in to the Algorithm Archive by either building on existing material or building into a new section?
  2. Are all sources linked and referenced appropriately such that readers can learn more information when or if they have the desire?
  3. Are the graphics related to the chapter clear and understandable?
  4. Does the code have an appropriate walk-through in the text and is it easy to modify to other languages?

Chapter maintenance / upkeep

The Algorithm Archive is an active platform for learning and discussion. As such, there may be requests for the modification or extension of your chapter content in the future. As a chapter contributor, you are not required to be present for discussions related to the modification of your chapter; however, we will always try to notify you when new code is contributed or when modifications are made, as you are the expert in all areas related to the chapter you have written. We will also notify you when any changes are made that modify the scope or organization of the Algorithm Archive in the future.

If you do not wish to take part in these discussions at any time in the future, please let James Schloss (Leios) know.

Clone this wiki locally