Develop a comprehensive set of contributor guidelines to help streamline contributions and maintain the quality of the JACoB project. The guidelines will include the following sections:
Files:
CONTRIBUTING.md (new file to be created in the root directory)
Guidelines Sections:
Introduction
Welcome message and purpose of the guidelines.
Code of Conduct
Link to the project's code of conduct.
Contribution Process
Detailed fork and pull request workflow.
Code Style and Conventions
Adherence to TypeScript standards and npm run build for linting.
Testing Requirements
Instructions for local testing to ensure changes meet existing standards.
How to Report Bugs/Issues
Use of GitHub Issues for bug reporting with detailed instructions.
Community and Communication
Invitation to join the project’s Slack channel.
Acceptance Criteria:
[ ] A CONTRIBUTING.md file is created with all the sections listed above.
[ ] The file is accessible from the root directory of the project.
[ ] The guidelines are clear, concise, and easy to follow.
Title: Create Contributor Guidelines for JACoB
Description:
Develop a comprehensive set of contributor guidelines to help streamline contributions and maintain the quality of the JACoB project. The guidelines will include the following sections:
Files:
Guidelines Sections:
npm run buildfor linting.Acceptance Criteria:
@jacob-ai-bot