Denis Cercasin

Sources for Contribution Guidelines

This file documents the external resources consulted while creating the Contributions.md file for the Rent Tracker project. Each source contributed to shaping the structure, tone, or specific content of the contribution guidelines.

Main References and Their Purpose

1. GitHub Docs – Setting Guidelines for Contributors

  • Purpose: Served as the starting point in exploration what Contributions.md can be
  • Used for:
    • Understanding what to include in contribution guidelines
    • Writing a welcoming tone for new contributors

2. How to Build CONTRIBUTING.md – contributing.md

  • Purpose: Offered a practical guide with real examples of effective contribution guidelines.
  • Used for:
    • Structuring the file with clear headings (e.g., “How to Contribute”, “Code Style”)
    • Emphasizing clarity and approachability
    • Inspiration

3. CodeWalnut Tutorial – Adding a CONTRIBUTING.md

  • Purpose: Provided technical instructions and best practices for creating and linking the file in the repository.
  • Used for:
    • File placement and naming
    • Markdown formatting examples

4. StackOverflow: What is GitHub CONTRIBUTING.md for?

  • Purpose: Clarified the practical impact and importance of the file from the open source community perspective.
  • Used for:
    • Understanding community expectations
    • Justifying the addition of the file to improve collaboration
    • Addressing common contributor questions

These examples were not directly copied but reviewed to understand how large projects organize and phrase their contribution processes, especially in open-source and community-driven settings.

Final Note

The Contributions.md file created for this project is a synthesis of the insights gathered from the above resources, tailored specifically to Rent Tracker’s goals, technologies, and workflow. All templates and content were adapted and rewritten to fit the context of a university software development project.