Contributing to cs‑research‑stack

A curated collection of Computer‑Science resources – journals, conferences, guides, checklists, and more. This document explains how you can add your own experience (Master’s, PhD, research projects) and improve the repository.

🎯 Who is this repository for?

  • Students & researchers looking for a ready‑made list of Q1 journals, high‑rank conferences, and practical career guides.
  • Practitioners who want a quick reference to the most reputable CS venues.
  • Contributors who want to share their own expertise (e.g., thesis topics, teaching resources, code snippets).

🛠️ How to contribute

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes, following the convention feature/<description> or fix/<issue>.
  3. Make your edits – add, update, or delete markdown files. Keep the existing style:
    • Use GitHub‑flavored markdown.
    • Keep tables aligned and include a short description for each entry.
    • Add a citation or a URL wherever possible.
  4. Run the linter (if the project provides one) to ensure formatting consistency.
  5. Open a Pull Request:
    • Title should be concise (e.g., Add Quantum Computing Q1 journals).
    • In the PR description, explain why the change is useful and reference any sources.
  6. Respond to reviewer feedback – iterate until the PR is approved.

📚 Adding your own experience

If you would like to showcase your own CS background (Master’s or PhD) within the repo, you can add a short author profile:

  1. Create a markdown file under career/ named YOUR_NAME‑profile.md (e.g., career/alice‑smith‑profile.md).
  2. Include the following sections: 
    # Your Name – Master/PhD in Computer Science

## Research Interests
- List of topics (e.g., Machine Learning, Distributed Systems, Formal Methods)

## Selected Publications
- *Title*, Venue, Year, DOI/URL

## Contributions to cs‑research‑stack
- What you added (e.g., new Q1 journal list for Quantum Computing, conference checklist).
  3. Link your profile from the main README.md (or a dedicated contributors.md) so visitors can discover it.

✅ Checklist for a clean contribution

  • Follow the repository’s markdown style (tables, headings, emojis).
  • Verify URLs are reachable (no dead links).
  • Update any relevant index files (e.g., awesome-lists.md) if you add new sections.
  • Run npm run lint or the project’s lint command if available.

📄 License & Code of Conduct

All contributions are licensed under the same terms as the repository (see LICENSE). By submitting a PR you agree to follow the Code of Conduct.

Happy contributing! 🎉