Skip to content

Fix links to not point to the old repository anymore and remove a file that shouldn't be here. #117

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

Merged
merged 4 commits into from
May 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion chapters/how_to_contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Right now, I feel comfortable writing the text associated with each algorithm an
In the future, I might allow other users to write algorithm chapters, but for now let's keep it simple: I'll do the writing, everyone else does the coding.
Now for some specifics on submissions:

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/leios/algorithm-archive/issues/18). I will leave the issue open for now in the case that other individuals have more to contribute there. 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.
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). I will leave the issue open for now in the case that other individuals have more to contribute there. 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.
2. **Licensing**: All the code from this project will be under the MIT licence found in `LICENCE.md`; however, the text will be under a Creative Commons Attribution-NonCommercial 4.0 International License.
3. **CONTRIBUTORS.md**: After contributing code, please echo your name to the end of `CONTRIBUTORS.md` with `echo name >> CONTRIBUTORS.md`, and also leave a comment on the top of the code you submitted with your name (or username) saying `// submitted by name`. This way everyone is held accountable and we know who to contact if we want more information.
4. **Building the Algorithm Archive**: If you want to build the Algorithm Archive on your own machine, install gitbook and use `gitbook serve` in the main directory (where `README.md` is). This will provide a local url to go to to view the archive in your browser of choice. Use this server to make sure your version of the Algorithm Archive works cleanly for the chapter you are updating!
Expand All @@ -32,4 +32,5 @@ Also note that depending on the algorithm, there might be in-text code snippets

I'll update this page as the project grows. Basically, when you submit code, it will be under an MIT license. Please keep the code clean and put your name (or username) in the `CONTRIBUTORS.md` file.

If you would like to be a part of the ongoing discussion, please feel free to join our discord server: https://discord.gg/pb976sY.
Thanks for all the support and considering contributing to the Algorithm Archive!
10 changes: 5 additions & 5 deletions chapters/principles_of_code/version_control.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Because of this, you may want to create a repository under your own github usern
![How to fork](fork.png)

Note that if you have a fork of a particular code repository, you can ask the owner of the original code repository to pull your changes into their version of the code with a *pull request*, but we are getting ahead of ourselves here.
If you cannot think of what repository to work on and want to collaborate on this project in the future, feel free to fork the [Algorithm Archive](https://github.com/leios/algorithm-archive) and modify that!
If you cannot think of what repository to work on and want to collaborate on this project in the future, feel free to fork the [Algorithm Archive](https://github.com/algorithm-archivists/algorithm-archive) and modify that!

Regardless, as long as there is a repository under your username on github, we can continue by linking that remote github location to your local git directory. First, we need to find the url of the github repository, as shown here:

Expand All @@ -77,15 +77,15 @@ Once you have the url, there are 2 ways to proceed:

**The easy way:**
```
git clone https://github.com/leios/algorithm-archive
git clone https://github.com/algorithm-archivists/algorithm-archive
```

**The not-so-easy way:**
```
mkdir algorithm_archive
cd algorithm_archive
git init
git remote add origin https://github.com/leios/algorithm-archive
git remote add origin https://github.com/algorithm-archivists/algorithm-archive
git fetch
git merge origin/master
```
Expand All @@ -95,7 +95,7 @@ For now, we will breifly describe each of the commands; however, we will definit
So, here it is, step-by-step:
1. `mkdir algorithm_archive`: make a directory. We can call this directory anything, but we'll call it algorithm_archive for now.
2. `git init`: initialize git
3. `git remote add origin https://github.com/leios/algorithm-archive`: add a remote location (the github url we found just a second ago). Again, we can call this remote location anything, but `git clone` always calls it `origin`, so well stick with that.
3. `git remote add origin https://github.com/algorithm-archivists/algorithm-archive`: add a remote location (the github url we found just a second ago). Again, we can call this remote location anything, but `git clone` always calls it `origin`, so well stick with that.
4. `git fetch`: update the local directory with the information from the remote online repository
5. `git merge origin/master`: merge those updates. Right now, the `origin/master` part of this command might seem like a bit of black octocat magic, but we will cover it in just a bit!

Expand All @@ -113,7 +113,7 @@ Actually, you probably were not asking that question. It's not an obvious questi
The solution is simple: Add another `remote` like so:

```
git remote add upstream https://github.com/leios/algorithm-archive
git remote add upstream https://github.com/algorithm-archivists/algorithm-archive
```

Obviously, you can call the remote anything. I kinda arbitrarily chose to call it `upstream`. By adding this in, you can easily interact with the same codebase from multiple remote locations.
Expand Down
197 changes: 0 additions & 197 deletions chapters/principles_of_code/version_control.md2

This file was deleted.