Project Repository setup/maintenance checklist¶
-
Define the repository structure: Choose the right directory structure for the project, taking into account where the source code, documentation, and test files should be.
-
Set up version control: Choose a version control system, such as Git, and initialize a repository for the project.
-
Establish a development workflow: Define the branching strategy, pull request process, and code review process.
-
Define coding standards: Establish guidelines for code style, naming conventions, and commenting standards.
-
Define the build process: Set up a continuous integration system and define the steps required to build and deploy the application.
-
Define the deployment process: Establish what needs to be done in order to deploy the application to production, such as environment setup, database migration, and security tests..
-
Define the testing process: Determine the types of tests to be run, including unit tests, integration tests, and acceptance tests, and establish a test plan.
-
Document the project: Document the project's architecture, deployment procedure, and development workflow in a project wiki or readme file and keep it up to date..
-
Establish a bug tracking process: Choose a bug tracking tool, such as JIRA, and establish a process for reporting and tracking bugs.
-
Define the code review process: Establish guidelines for code reviews, including how often they should occur, who should be involved, and how feedback should be given.
-
Establish a communication plan: Determine how the team will communicate with each other, including regular meetings, status updates, and code review feedback.
Must have Artifacts:
-
Development Workflow documentation - should be complete
-
Coding Standards documentation - should be complete
-
Code review process documentation - should be complete
-
Start documenting Project wiki/readme, architecture
-
PR template
-
Ticket templates (bugs/ stories)