-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cleanup & Add contribution guide (#42)
* chore: moving to folders * fix: broken links * add: contributing guide * diagram to newline * fix readme * Update .github/CONTRIBUTING.md Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * Update .github/CONTRIBUTING.md Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> --------- Co-authored-by: Omar Sanseviero <osanseviero@gmail.com>
- Loading branch information
1 parent
2e1c199
commit 4e67168
Showing
26 changed files
with
68 additions
and
23 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 @@ | ||
# Welcome to the contribution guide 🤗 | ||
|
||
We are excited to invite the community to contribute to the repository! We appreciate all contributions, big or small. Your efforts help make this repository a valuable resource for everyone working with Llama models. | ||
|
||
Thank you for your time and happy coding! | ||
|
||
## 🚀 How to Contribute | ||
|
||
1. **Fork the Repository** | ||
- Click on the "Fork" button at the top right corner of this page to create your own copy of the repository. | ||
|
||
 | ||
|
||
2. **Create a Branch** | ||
- In your forked repository, create a new branch for your contribution: | ||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
3. **Make Your Changes** | ||
- Add your scripts, notebooks, or any relevant files. | ||
- **Don't forget to update the `README.md`** to include your example, | ||
so others can easily find and use it. | ||
4. **Commit and Push** | ||
- Commit your changes with a meaningful commit message: | ||
```bash | ||
git commit -m "Add feature: your feature name" | ||
``` | ||
- Push the changes to your forked repository: | ||
```bash | ||
git push origin feature/your-feature-name | ||
``` | ||
5. **Open a Pull Request** | ||
- Navigate to the original repository and click on "New Pull Request" | ||
- Compare across forks and select your branch. | ||
 | ||
- Provide a clear description of your contribution. | ||
## 💡 Need Help? | ||
If you have any questions or need guidance, feel free to open an issue or draft PR. We're here to help! |
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
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 @@ | ||
.DS_Store |
File renamed without changes.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.