ClyCites / ClyCites-Frontend

This Repo consists of all frontend of our Project
MIT License
1 stars 2 forks source link

[Feature] Create a Detailed CONTRIBUTING.md File #12

Open danielmarv opened 1 month ago

danielmarv commented 1 month ago

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:

  1. Create a new CONTRIBUTING.md file at the root of the repository.
  2. 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:


Acceptance Criteria:

eliezerjoel commented 1 month ago

Hello, Assign me this I'm working on it already