Skip to content

Add a "Contributing" Section to the README #1

@AdithyanKP

Description

@AdithyanKP

Description

We need to add a "Contributing" section to the README file to provide guidance for new contributors. This section should include:

  • Setting Up the Development Environment: Instructions on how to get the project up and running locally.
  • Coding Standards and Best Practices: Guidelines for writing and submitting code.
  • How to Submit a Pull Request: Steps for contributing code changes.
  • Branching Guidelines: Information on how to work with branches.

Branching Guidelines

  1. Create a Branch: When working on a new feature or bugfix, create a branch from develop:
  2. Make Changes: Implement your changes or additions in this branch.
  3. Submit a Pull Request: Once your work is ready, push your branch to GitHub and submit a pull request to the develop branch. This will allow for code review and integration into the project.

Steps to Reproduce

  1. Open the README.md file.
  2. Add a new section titled "Contributing" with the required information.
  3. Save and commit your changes.

Additional Information

Feel free to look at other projects' contributing guidelines for reference or inspiration. If you have any questions, don't hesitate to ask!

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions