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

Enhance Documentation in the Project #76 #82

Merged
merged 7 commits into from
Oct 30, 2024
Merged

Enhance Documentation in the Project #76 #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7ed2c60
Create directories and move files
josephpdf Oct 25, 2024
12f5f38
Add template for New Issues
josephpdf Oct 25, 2024
22bb8e8
Modify reference in README.md
josephpdf Oct 25, 2024
32d86a4
Update TEMPLATE.md
josephpdf Oct 25, 2024
b9a32e2
Update name file
josephpdf Oct 26, 2024
299a499
Update ISSUE_TEMPLATE.md
josephpdf Oct 28, 2024
edaf793
Merge branch 'main' into documentation
danielcdz Oct 30, 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
11 changes: 11 additions & 0 deletions .github/templates/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Issue
### 📖 Description
- Issue description
### 📓 Summary
- Brief summary of the issue
### 📦 Deliverable
- File or files to deliverable in this issue
### 📚 References
- Some references to the repository
### ⚠️ Notes
- Important notes for the issue
0 .github/PULL_REQUEST_TEMPLATE.md → .github/templates/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @josephpdf, please use the following structure for this Pull Request Template:

Pull Request Overview

📝 Summary

  • Closes # number issue
  • Brief summary

🔄 Changes Made

  • Add changes made

🔧 Tests Results

  • Add images to validate your results

File renamed without changes.
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,7 @@ make setup
```

## Contribution 🤝

We welcome contributions from developers of all levels! If you're interested in contributing to this project, please follow our [CONTRIBUTION GUIDELINES](./CONTRIBUTION.md) to get started.
We welcome contributions from developers of all levels! If you're interested in contributing to this project, please follow our [CONTRIBUTION GUIDELINES](./docs/contribution/CONTRIBUTION.md) to get started.

Whether it's fixing bugs, improving documentation, or adding new features, your help is greatly appreciated. Don't hesitate to ask questions or reach out for support—we're here to help!

Expand Down
0 CONTRIBUTION.md → docs/contribution/CONTRIBUTION.md
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @josephpdf, please update this file CONTRIBUTION.md by adding the content/file from: Contribution Guidelines Thanks! 🫡

File renamed without changes.
Loading