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.

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

docs: generate documations #37

Merged
merged 12 commits into from
Jan 15, 2025
Merged

docs: generate documations #37

merged 12 commits into from
Jan 15, 2025

Conversation

arashagp
Copy link
Member

@arashagp arashagp commented Jan 15, 2025

Description

Tasks

Code & Documentation:

  • 📝 Self-Review: Thoroughly review your code changes.
  • 📚 Code Documentation: Update/create all necessary in-code documentation.
  • 📖 User Guides (If Applicable): Add necessary guides to README or other help files.
  • 🎨 Formatting: Ensure code is properly formatted.

Project Management & Tracking:

  • 📅 Daily Report (If Applicable): Record changes in the company's daily report.
  • ⬆️ GitHub Management: Ensure PR is assigned, added to the correct project, and has appropriate labels. Confirm it adheres to the single purpose principle.
  • 🏷️ Set Label: Select and apply the appropriate label(s) for this pull request (e.g., bug, feature, enhancement, documentation). This helps categorize and track the changes.
  • 🎯 Single Purpose PR: Confirm this PR addresses a single, well-defined change.

Deployment & Testing (If Applicable):

  • 🔄 Rebase: Ensure your branch is rebased and updated.
  • Local Deployment Testing: Deploy and test locally if changes affect functionality.

@arashagp arashagp requested a review from njfamirm as a code owner January 15, 2025 05:34
@arashagp arashagp added the documentation Solely about the documentation of the project. label Jan 15, 2025
@njfamirm njfamirm merged commit 030b030 into next Jan 15, 2025
2 checks passed
@njfamirm njfamirm deleted the docs/generate-documations branch January 15, 2025 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Solely about the documentation of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants