microsoft / microsoft/azure-devops-python-api

Clarify how to contribute to this repo

Open
#439 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
684
Forks
218
Avg merge
8d 10h
Merged PRs (30d)
1

Description

The "Contributing" section of README.md states that this "This project welcomes contributions and suggestions"

However, nearly every file in azure-devops/azure/devops states

# Generated file, DO NOT EDIT
# Changes may cause incorrect behavior and will be lost if the code is regenerated.

It is unclear what the correct process is to propose changes, as well as how to regenerate these files.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with README.md and the generated-file notices under azure-devops/azure/devops. Determine the repository's supported contribution and regeneration process, then document both in README.md. Done means a newcomer can tell where changes belong and how to regenerate the files.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.