Skip to content

Commit

Permalink
moved documents around, contribute guide fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
DreadKnight committed May 4, 2019
1 parent 3d5d32d commit 7c708ba
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 10 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
If your pull request tries to address a specific issue from the repository, please reference to it.
Don't forget to include a description of the changes proposes. https://discord.me/AncientBeast
Don't forget to include a description of the changes proposes. https://discord.me/AncientBeast
2 changes: 1 addition & 1 deletion docs/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project founder at <[email protected]>. All
reported by contacting the project founder at <mailto:[email protected]>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
4 changes: 0 additions & 4 deletions docs/CONTRIBUTING.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,6 @@ If you encounter any problems with this version, you can report them to our [Git
Very often, it will be very helpful for debugging purposes to fetch game logs when encountering issues. You can use the `AB.getLog()` function from the browser console window in order to fetch the current match log.
In order to open up Google Chrome browser's console, you can press `Ctrl + Shift + J`. To replay a match, you'll have to be in the pre-match screen, paste its log in the console and then press the `Return` key.

![example restore log](/docs/img/game-log.png)

### Patch Game

The main coding language used is Javascript, feel free to create patches and propose them by making a Pull Request.
Expand All @@ -108,8 +106,6 @@ localhost:8080

Keep in mind that you'll have to refresh the webpage after making changes. Make sure to disable browser caching by using `Ctrl + Shift + J`, then going to the **Network** tab and checking **Disable cache**.

![disable cache](/docs/img/disable-cache.png)

### Next Step

You are free to browse [existing issues](https://github.com/FreezingMoon/AncientBeast/issues) and comment on the ones that you want to take a swing at in order to make sure the issue is still relevant and that nobody else is working on it. You can also drop by the project's [Discord server](https://discord.gg/x78rKen) and mention your skills and that you're interested in helping out; you'll be assigned to a specific issue. When you're done, simply create a **Pull Request**. Note that you might need to pull in from master repository before doing so. Your patches will get reviewed and tested, if there are issues with them, you'll receive feedback in order to make corrections. Otherwise, your pull request will get approved and merged into the master branch and you'll be credited for your work.
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,16 @@ What we're aiming for are the following:

You can check it out via our auto-deployed Heroku build: https://ancientbeast-beta.herokuapp.com [ Unstable! ]

### [Contribute](docs/CONTRIBUTING.md#readme)
### [Contribute](CONTRIBUTING.md#readme)

You can help out the project by just ★ starring this repository from the [upper right corner](#) and also by pinning it to your profile.
If you wish to set-up a local copy of the game in order to patch it, go read the ["CONTRIBUTING.md"](https://github.com/FreezingMoon/AncientBeast/blob/master/docs/CONTRIBUTING.md#readme) file from this repository.
There are more ways in which you can help out this project, check out the ["Make Your Contribution"](https://ancientbeast.com/contribute) guide to get things going!
You can help out the project by just ★ starring this repository from the [upper right corner](#) and also pinning it to your profile.
If you wish to set-up a local copy of the game in order to patch it, go read the ["CONTRIBUTING.md"](https://github.com/FreezingMoon/AncientBeast/blob/master/CONTRIBUTING.md#readme) file from this repository.
There are more ways in which you can help out this project, check out the ["Make Your Contribution"](https://ancientbeast.com/contribute) guide and get it going!

### Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].

<a href="https://github.com/FreezingMoon/AncientBeast/graphs/contributors"><img src="https://opencollective.com/AncientBeast/contributors.svg?width=972&button=false" /></a>

### Backers
Expand Down
Binary file removed docs/img/disable-cache.png
Binary file not shown.
Binary file removed docs/img/game-log.png
Binary file not shown.

0 comments on commit 7c708ba

Please sign in to comment.