Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a CONTRIBUTING.md file #17

Closed
Saachi26 opened this issue Oct 6, 2024 · 8 comments
Closed

Create a CONTRIBUTING.md file #17

Saachi26 opened this issue Oct 6, 2024 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Saachi26
Copy link
Collaborator

Saachi26 commented Oct 6, 2024

Create a CONTRIBUTING.md file. This file will serve as a guide for potential contributors, outlining the steps and guidelines for contributing effectively to the project.

Proposed Structure for CONTRIBUTING.md

  • Setting up the project: Instructions on forking the repository, cloning, and creating a new branch.
  • Code of Conduct: Reference to a code of conduct for maintaining a respectful community.
  • Issues: Guidelines for reporting bugs and requesting features.
  • Pull Requests: Instructions on how to submit a pull request, including guidelines for descriptions and linking issues.
  • Commit Messages: Standards for writing clear commit messages.
  • Coding Guidelines: Information about the tech stack and coding style to follow.
  • Development Workflow: Steps for running the development environment, testing, and building the project.
  • License: Information regarding the project's license.
@Saachi26 Saachi26 added the documentation Improvements or additions to documentation label Oct 6, 2024
@ifeelsam
Copy link
Contributor

ifeelsam commented Oct 6, 2024

can i?

@MadhavKrishanGoswami
Copy link
Owner

Absolutely go ahead!

@ifeelsam
Copy link
Contributor

ifeelsam commented Oct 6, 2024

i added necessary stuff, didn't feel like adding too much stuff to overwhelm the contributors, happy to add it if that's what you want you can see the the pr #25

@AnujSaha0111
Copy link
Contributor

I want to work on it. Can you please assign it to me?

@MadhavKrishanGoswami
Copy link
Owner

@AnujSaha0111 Absolutely, I'd love to have you contribute! Let's just wait for @ifeelsam to confirm if they're working on it. If not, you can go ahead and pick it up!

@MadhavKrishanGoswami
Copy link
Owner

Hello! @AnujSaha0111 you can start working on this!

@AnujSaha0111
Copy link
Contributor

Hello! @AnujSaha0111 you can start working on this!

Solved it #33

@Dipanita45
Copy link

I want to work on this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants