Rune Harlyk
39 lines
1.5 KiB
Markdown
39 lines
1.5 KiB
Markdown
# Contributing
|
||
|
||
> *Prerequsition*: You have made it through the documentation and are wondering what you can do to make the robot dogs bark even louder.
|
||
|
||
## Getting Started
|
||
|
||
1. Fork the Repository
|
||
- Click the Fork button at the top right corner to create a copy of this repository on your account.
|
||
|
||
1. Clone Your Fork
|
||
- On your GitHub fork, click the “Clone or download” button, copy the URL, and run git clone [URL] in your terminal.
|
||
|
||
1. Create a Branch
|
||
- Navigate into the repository directory on your computer.
|
||
- Create a new branch using git checkout -b your-branch-name.
|
||
|
||
## Making Changes
|
||
|
||
1. Make Your Changes
|
||
- Open the project in your editor/IDE and make your changes or additions.
|
||
|
||
1. Commit Your Changes
|
||
- After making changes, stage them using git add .
|
||
- Commit the changes with a meaningful message using git commit -m "Brief description of changes".
|
||
|
||
## Submitting Contributions
|
||
|
||
1. Push to Your Fork
|
||
- Push your branch changes to your fork with git push origin your-branch-name.
|
||
1. Create a Pull Request
|
||
- Go to the original repository on GitHub.
|
||
- You’ll see a "Compare & pull request" button. Click it, review your changes, then submit your pull request with a clear description of the enhancements or fixes.
|
||
|
||
## After Submission
|
||
|
||
- Wait for the project maintainers to review your pull request. They might suggest some changes. Keep an eye on your GitHub notifications for feedback or merge information.
|
||
|
||
Thank you for contributing!
|