Add a CONTRIBUTING.md so new people know the rules
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Read the README’s existing contribution steps and check the repository’s solution files to confirm naming, placement, and header comment conventions. Create a friendly CONTRIBUTING.md covering those conventions, how to check a solution, PR titles, and where to ask for help. It is done when the guide covers each listed topic and matches the repository’s current practices.
Written by the indexing model from the issue text.
Description
Right now the contribution steps live only in the README. A separate CONTRIBUTING.md gets linked automatically by GitHub when someone opens a PR or issue.
Time: about 30 minutes
Skills: writing
It should cover
- How to name and place a solution file
- The header comment format (problem, link, note)
- How to run or check a solution before submitting
- What a good PR title looks like
- Where to ask for help
Keep the tone friendly. This repo is aimed at first-timers.
Who can take this
Anyone. Beginners, experienced developers, students, and people who do not code. Any language, any level. If you want to help, you are welcome here.
How to contribute
- Comment on this issue so nobody else starts the same thing
- Fork the repo
- Clone your fork and create a branch
- Make your change
- Commit, push, and open a Pull Request
Never opened a pull request before? Start with First Contributions or watch this walkthrough.
Stuck on anything? Ask in the comments. Basic questions are fine.
If this repo helps you or you like where it is going, a star is a nice way to say thanks and helps other people find it. Entirely optional, and you do not need it to contribute.
- Dominant language
- Python
- Stars
- 3
- Forks
- 2
- Avg merge
- 2h 33m
- Merged PRs (30d)
- 6
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Huerte/algo-solutions-python
-
5-minutes algorithm all-levels any-language beginner-friendly codewars easy good first issue hackerrank hacktoberfest help wanted interview-prep leetcode open-source students
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Huerte/algo-solutions-python#144 · 1 comment ·
-
30-minutes community documentation enhancement good first issue hacktoberfest help wanted
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Huerte/algo-solutions-python#143 ·
-
5-minutes all-levels beginner-friendly codewars documentation good first issue hackerrank hacktoberfest interview-prep leetcode no-code-needed open-source students
Difficulty 2/5 Under an hour Newbie friendliness 68/100
Huerte/algo-solutions-python#140 ·
-
15-minutes 5-minutes algorithm any-language beginner-friendly c cpp csharp easy go good first issue hacktoberfest help wanted java javascript kotlin python rust swift typescript
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Huerte/algo-solutions-python#138 ·
-
30-minutes algorithm all-levels beginner-friendly codewars data-structures documentation dynamic-programming good first issue hackerrank hacktoberfest help wanted interview-prep leetcode no-code-needed open-source students
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
Huerte/algo-solutions-python#134 ·
All issues in Huerte/algo-solutions-python
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
Maintainers usually reply within 4 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
ClockGU/clockwork-backend#169 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
aws-samples/sample-per-model-bedrock#616 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
chnm/teachinghistory-hugo#47 ·
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
pandas-dev/pandas-stubs#2047 · 2 comments ·
Maintainers usually reply within 1 day