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

Updating Readme.md file and adding issue and pull request template #18

Open
MAVRICK-1 opened this issue Jan 13, 2024 · 0 comments
Open

Comments

@MAVRICK-1
Copy link
Contributor

MAVRICK-1 commented Jan 13, 2024

Updating Readme.md

Updating the README.md file to guide new contributer on setting up the library locally and listing the necessary requirements. For instance, the py-radix library requires Microsoft Visual C++ 14.0 or a later version.

Issue and pull Request template

Issue and pull request templates in GitHub serve as predefined structures for creating new issues or pull requests. They provide a standardized format and set of information that contributors should include when opening issues or submitting pull requests. Here's how they help:

  1. Consistency: Templates ensure that contributors provide essential details in a standardized format. This consistency makes it easier for maintainers to understand the issue or pull request promptly.

  2. Information Gathering: Templates guide users to provide relevant information, such as a clear description, steps to reproduce, or a summary of changes. This reduces back-and-forth communication and helps in faster issue resolution or pull request acceptance.

  3. Reduced Ambiguity: By specifying the information required, templates reduce ambiguity and clarify expectations. This is particularly beneficial when contributors are less familiar with the project or when dealing with complex issues.

  4. Documentation: Templates can include helpful instructions, tips, or links to documentation, making it easier for contributors to navigate the contribution process. This can be especially valuable for new contributors.

  5. Streamlined Workflow: With templates, contributors follow a structured workflow, which simplifies the process of handling issues and pull requests. It ensures that the necessary information is available upfront.

@romain-fontugne what's your view on this?
can you assign me?

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

No branches or pull requests

1 participant