-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Contributing to Linkarooie | ||
|
||
Welcome! If you're interested in contributing to Linkarooie, here's a quick guide to get you started. | ||
|
||
## How to Contribute | ||
|
||
1. **Fork the Repository**: Start by forking the repository to your own GitHub account. | ||
|
||
2. **Clone Your Fork**: Clone your fork to your local machine. | ||
|
||
```bash | ||
git clone https://github.com/your-username/linkarooie.git | ||
``` | ||
|
||
3. **Create a New Branch**: Make changes on a separate branch. | ||
|
||
```bash | ||
git checkout -b your-feature-branch | ||
``` | ||
|
||
4. **Make Your Changes**: Work on your feature, bug fix, or documentation update. Keep your changes concise and focused. | ||
|
||
5. **Test Your Changes**: Ensure that all tests pass and the project builds correctly. | ||
|
||
6. **Submit a Pull Request**: Once you're happy with your changes, push them to your fork and submit a pull request to the `main` branch. | ||
|
||
## Guidelines | ||
|
||
- **Quality**: Code should be clean, well-documented, and follow the project's existing coding style. | ||
- **Relevance**: Contributions should align with the project's goals and add meaningful improvements or fixes. | ||
- **Passive Contributions**: Feel free to contribute at your own pace. I may review and merge pull requests if I find them valuable. | ||
|
||
## Feedback and Reviews | ||
|
||
- Contributions are welcome, but I reserve the right to accept or decline pull requests based on their relevance and quality. | ||
- I may not actively review all contributions immediately, but if I like what I see, I might merge it. | ||
|
||
## Thank You | ||
|
||
Your interest in improving Linkarooie is greatly appreciated. Even small contributions can make a big difference! | ||
|
||
Happy coding! | ||
|
||
Dean Lofts | ||
[[email protected]]([email protected]) |