search

yashrajb / devtrackr-vscode-extension

Track and Document Your Weekly Work with devtrackr!
https://marketplace.visualstudio.com/items?itemName=yashrajbasan.devtrackr
GNU General Public License v3.0
9 stars 4 forks source link

[DOCS] add other sections to improve README.md #2

Closed rubemfsv closed 11 months ago

rubemfsv commented 11 months ago

Adding an "Issues," "Branches," "Contributions," and "Contributors" section to your README in a project's repository can provide valuable information and transparency to both contributors and users of your project. Here's why you might consider adding these sections:

  1. Issues Section:

    • Transparency: It demonstrates that you welcome feedback and bug reports from users and contributors.
    • Organization: It provides a central place for users and contributors to report and track issues, making it easier to manage and prioritize them.
    • Instructions: You can include guidelines on how to report issues effectively, which can help streamline the issue submission process.

  2. Branches and Contributions Section:

    • Navigation: It helps users and contributors understand which branches are considered stable, development, or feature branches.
    • Encouragement: It encourages other developers to contribute to your project by outlining how they can do so.
    • Guidelines: You can include guidelines for contributing, such as coding standards, pull request procedures, and code review expectations.

  3. Contributors Section:

    • Recognition: It acknowledges and credits individuals who have contributed to the project, giving them recognition for their efforts.
    • Community Building: It helps build a sense of community around the project by showcasing the people who have helped improve it.

Including these sections in your README can make it easier for both newcomers and experienced users to understand how to engage with your project, report issues, contribute code, and navigate the repository effectively. It promotes transparency, collaboration, and a welcoming environment for potential contributors and users.

If you accept, put the hacktoberfest-accepted tag, please.

yashrajb commented 11 months ago

@rubemfsv Some changes are required in the 'Branches and Contribution' section. If anyone wants to contribute, they should first fork the repository and then, after making changes, create a pull request. Also, please change the name of this section to 'Contribute.' It will be helpful if you list down the steps for contribution.

Furthermore, in the last section, please remove Solace.js

rubemfsv commented 11 months ago

@yashrajb I did the changes