You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
Acceptance Criteria:
The text was updated successfully, but these errors were encountered: