diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd4b7865a9..4b142c63d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,7 +45,7 @@ npm start 5. Open your browser at http://localhost:8080. You should see the same content as on https://open-pixel-art.com just with a grid on the canvas that helps you better place your pixel. ----- +--- There is also an option for setting up the project via Docker. To get started with the project by using Docker follow the following steps. @@ -61,8 +61,7 @@ There is also an option for setting up the project via Docker. To get started wi docker run -d -p 8080:8080 -it open-pixel-art ``` - -If the docker image fails to build there's probably an error in your code and the tests fail to pass. If everything is correct you can easily connect by visiting the following url http://localhost:8080. You should see the same content as on https://open-pixel-art.com just with a grid on the canvas that helps you better place your pixel. +If the docker image fails to build there's probably an error in your code and the tests fail to pass. If everything is correct you can easily connect by visiting the following url http://localhost:8080. You should see the same content as on https://open-pixel-art.com just with a grid on the canvas that helps you better place your pixel. You can also verify if it's running by doing `docker ps --all` You will see an image called `open-pixel-art` and where you can access it as well. @@ -134,7 +133,7 @@ The commit message is following the [Conventional Commits Standard](https://www. ### Push Your Changes and Creating a Pull Request -**Note:** If you're having trouble pushing your changes to GitHub, your local branch of the repository may not be up-to-date with the current repository because of additions from other contributors. Before you push your changes to GitHub, you might need to [sync your fork with the upstream repository](https://help.github.com/en/articles/syncing-a-fork). +**Note:** If you're having trouble pushing your changes to GitHub, your local branch of the repository may not be up-to-date with the current repository because of additions from other contributors. Before you push your changes to GitHub, you might need to [sync your fork with the upstream repository](https://help.github.com/en/articles/syncing-a-fork). Try run `npm run sync-fork` to sync your fork automatically. Push your changes to GitHub by running: diff --git a/docs/MAINTAINERS.md b/docs/MAINTAINERS.md index 98eb15adda..50e0b6791f 100644 --- a/docs/MAINTAINERS.md +++ b/docs/MAINTAINERS.md @@ -33,11 +33,11 @@ These are some guides on how to deal with those PRs - there should not be any other files touched - the coordinates of the pixel should be less than `40` - if this is the case, you can use the following message template to request changes - > Hey @dkundel it seems like that someone unfortunately already grabbed the pixel you are trying to contribute. Could you please [sync your fork](https://help.github.com/en/articles/syncing-a-fork) or run `npm run sync` and contribute a different pixel instead? Thank you for your contribution! + > Hey @dkundel it seems like that someone unfortunately already grabbed the pixel you are trying to contribute. Could you please [sync your fork](https://help.github.com/en/articles/syncing-a-fork) or run `npm run sync-fork` and contribute a different pixel instead? Thank you for your contribution! - the `username` should be the same as their GitHub username they are using to open the PR - they are not overriding another person's pixel - if this is the case, you can use the following message template to request changes - > Hey @dkundel it seems like that you grabbed the pixel that is outside of the canvas. Any coordinate needs to be smaller than 40. Could you please [sync your fork](https://help.github.com/en/articles/syncing-a-fork) or run `npm run sync` and contribute a different pixel instead? Thank you for your contribution! + > Hey @dkundel it seems like that you grabbed the pixel that is outside of the canvas. Any coordinate needs to be smaller than 40. Could you please [sync your fork](https://help.github.com/en/articles/syncing-a-fork) or run `npm run sync-fork` and contribute a different pixel instead? Thank you for your contribution! 3. Check if the PR has a merge conflict. You can see it at the bottom of the page. If there is a merge conflict: 1. Press the `Resolve conflict` button 2. Generally press `Accept Current`. The only exception is if the conflict involves the user who created the PR. In that case: