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.

Sign up for GitHub

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

Jump to bottom

Created Running Instructions & Added Contribution Instructions #37

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Created Running Instructions & Added Contribution Instructions #37

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4d0ea6
Added Launching and Contriburting Instructions to README
catrinalim Sep 25, 2024
b769be3
Created Running and Contributing Instructions
catrinalim Sep 25, 2024
540c3a6
Updated README and fixed spelling errors
catrinalim Sep 25, 2024
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
50 changes: 50 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,60 @@ Make intuitve pixel art in this simple drawing tool written in _vanilla javascri
| color swap | C |


## Launching and Running
Get the source code locally by navigating to your desired directory.
Clone the repositry using the following command:
```bash
git clone https://github.com/Kully/pixel-paint.git
```
Open the pixel-paint folder in the newly cloned folder.
Copy link
Owner

Choose a reason for hiding this comment

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

Please add a slash after pixel-paint: it should look like pixel-paint/.

Launch index.html locally. It should open a tab in your broswer.
Copy link
Owner

Choose a reason for hiding this comment

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

Typo: broswer should be browser.

The program is now running locally! Go and create your own art!


## Contributing

One of the joys of posting this project on Github is to get people excited and wanting to contribute to them. Feel free to create Pull Requests for any changes that you think the app could benifit from, or something that you would like to use.

Have a look at some of the [Issues](https://github.com/Kully/pixel-paint/issues) in the repo. If you see something you want to add or comment on, by all means do so!

How to Contribute:
1. Fork the repository.
2. Click on the "Clone" button and copy your unique link. It should look something like:
```bash
https://github.com/<username>/pixel-paint
```
3. Clone the repo:
``` bash
git clone https://github.com/<username>/pixel-paint
```
4. Navigate inside the cloned repo:
```bash
cd pixel-paint
```
4. Create a new branch:
```bash
git checkout -b <branch-name>
```
5. Make changes and add your new features/improvements you think benefits the app. Have fun and be creative!
Copy link
Owner

Choose a reason for hiding this comment

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

Can you remove steps 6 - 8 please? These are basic git controls that future contributors should already know about.

Beyond this, I don't think it is always good practice to commit all files at once when working on a feature. It is best to make one small change, then give a specific commit that describes the change, then push.

As an aside, I think it would be great to ask people to use Semantic Commits Messages. I am already doing this on other projects (professional and personal) so would be nice to ask people to do the same here. :)

Copy link
Owner

Choose a reason for hiding this comment

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

Can you remove "have fun and be creative!"?

I appreciate the fun suggestion, but I think we should just be focusing on the instructions here.

WDYT?

6. Add the newly edited files to git:
```bash
git add .
```
Note: This command adds all edited files to be commited. To commit specific files, see this [git documentation](https://git-scm.com/docs/git-add).
7. Commit your changes:
```bash
git commit -m "Detailed description of changes"
```
8. Push your code to your branch:
```bash
git push origin <branch-name>
```
9. Create your Pull Request:
Copy link
Owner

Choose a reason for hiding this comment

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

Are all these steps necessary for Step 9? Again, this seems like basic git practice that people should know.

It also might be confusing if people's user experiences of Github are different. Mobile vs Web? If Github changes their GUI in the future? etc.

- In your forked repo, click the green button labeled "Compare & pull request"
- Create a clear title with detailed descriptions of your changes
- Click the green button "Create pull request" to create the PR
- Congratulations your PR has been created!
10. Wait until feedback comes and for it to get reviewed!

Have fun and be creative! :art: