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

Initial Documentation #10

Closed
4 tasks done
AMAN-BARBARIA opened this issue Aug 1, 2023 · 0 comments
Closed
4 tasks done

Initial Documentation #10

AMAN-BARBARIA opened this issue Aug 1, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation task Ticket to work on
Milestone

Comments

@AMAN-BARBARIA
Copy link
Member

AMAN-BARBARIA commented Aug 1, 2023

Goal: Add essential documentation to our repository including: directory structure, local setup guide, PR submission guidelines, and license file.

Background: Our repository should contain some key documentation to make it easier for new contributors to understand the project structure, set up the project locally, contribute effectively via PRs, and understand the terms under which the project can be used or contributed to.

Tasks:

  • Create a 'Directory Structure' document that outlines the organization of our codebase, explaining the purpose of each directory and its key files.
  • Write a 'Local Setup' guide that provides step-by-step instructions for setting up the project locally for development purposes.
  • Develop 'PR Submission Guidelines' to standardize how contributors should create and submit their Pull Requests.
  • Add a 'LICENSE' file that clearly states the terms under which the project can be used or contributed to.

Acceptance Criteria:

  • All four documents are added to the repository and are easily discoverable (e.g., in the root directory or linked from the README).
  • The documents are clear, concise, and helpful to new contributors.
  • The LICENSE file accurately represents the terms under which we want to allow use of and contributions to our project.
@AMAN-BARBARIA AMAN-BARBARIA converted this from a draft issue Aug 1, 2023
@AMAN-BARBARIA AMAN-BARBARIA added enhancement New feature or request task Ticket to work on documentation Improvements or additions to documentation and removed enhancement New feature or request labels Aug 1, 2023
@AMAN-BARBARIA AMAN-BARBARIA added this to the v0.1.0 milestone Aug 1, 2023
@Raj-Shah1 Raj-Shah1 self-assigned this Aug 21, 2023
@Raj-Shah1 Raj-Shah1 moved this from Ready to Done in SalesSparrow Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation task Ticket to work on
Projects
Status: Done
Development

No branches or pull requests

2 participants