We need a well-structured and detailed CONTRIBUTING.md file to guide contributors on how to effectively participate in the ClyCites project. The file should include information on how to get started, coding standards, how to submit issues and pull requests, and other essential guidelines for contributions.
Tasks:
Create a new CONTRIBUTING.md file at the root of the repository.
Include the following sections in the file:
Getting Started: How to clone the repository, install dependencies, and set up the development environment.
Code of Conduct: Add a link to our project's code of conduct.
How to Contribute:
Reporting Bugs
Suggesting Features
Improving Documentation
Submitting Code (with information on how to fork, branch, and submit a pull request)
Development Guidelines:
Folder structure
Coding standards (mention ESLint, Prettier, etc.)
Commit message guidelines (with examples like feat:, fix:, etc.)
Pull Request Process: A step-by-step guide on creating and submitting a PR.
License: Add a note that contributions will be licensed under the project's license (e.g., MIT).
Resources:
[Existing code structure in the repository]
[Code of Conduct file]
Acceptance Criteria:
The CONTRIBUTING.md file should be well-organized and easy to follow.
It should include all the sections and details as described in the task list.
Title: Create a Detailed CONTRIBUTING.md File
Description:
We need a well-structured and detailed
CONTRIBUTING.md
file to guide contributors on how to effectively participate in the ClyCites project. The file should include information on how to get started, coding standards, how to submit issues and pull requests, and other essential guidelines for contributions.Tasks:
CONTRIBUTING.md
file at the root of the repository.feat:
,fix:
, etc.)Resources:
Acceptance Criteria:
CONTRIBUTING.md
file should be well-organized and easy to follow.