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

[DOCS] Create CONTRIBUTING.md and Update README.md #8

Closed
rubemfsv opened this issue Oct 2, 2023 · 4 comments
Closed

[DOCS] Create CONTRIBUTING.md and Update README.md #8

rubemfsv opened this issue Oct 2, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest

Comments

@rubemfsv
Copy link
Owner

rubemfsv commented Oct 2, 2023

Description

Please create a CONTRIBUTING.md file with detailed instructions for contributors and then update the README.md file to include a link to the CONTRIBUTING.md file.

Expected Behavior

The CONTRIBUTING.md file should be created, providing clear instructions on how contributors can contribute to our project. The README.md file should be updated to include a section with a link to the CONTRIBUTING.md file, making it easy for potential contributors to find the guidelines.

Actual Behavior

Currently, we lack a CONTRIBUTING.md file, which can make it challenging for new contributors to understand how they can get involved in our project effectively. By creating this file and linking it in the README, we can improve the onboarding experience for contributors.

Screenshots (if applicable)

N/A

Additional Information

Creating a CONTRIBUTING.md file is a standard practice in open-source projects. It helps maintainers and contributors collaborate more effectively by providing guidelines on code contributions, issue reporting, and other essential processes. Please refer to best practices and examples like the one found at pact-foundation/pact-js CONTRIBUTING.md to create our own CONTRIBUTING.md file.

@rubemfsv rubemfsv added documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest labels Oct 2, 2023
@the-amazing-atharva
Copy link
Contributor

hello @rubemfsv I would like to work on this issue for hacktoberfest

@rubemfsv
Copy link
Owner Author

rubemfsv commented Oct 3, 2023

@the-amazing-atharva
Copy link
Contributor

@the-amazing-atharva follow this example: https://github.com/rubemfsv/clean-react-app

Ok so like I have to copy paste and just edit the details for this repository right?

@rubemfsv
Copy link
Owner Author

rubemfsv commented Oct 4, 2023

@the-amazing-atharva yes! it would be ok

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 good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants