mesa / mesa/mesa-examples

Add Contributing.md file & edit related files

Open
#11 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
252
Forks
279
Avg merge
8d 9h
Merged PRs (30d)
2

Description

We need to add a contributing.md file to this repo. This is an extension of this ticket: https://github.com/projectmesa/mesa/issues/963#issuecomment-1316785220, but it can be broken out separately.

AC:
- [ ] A contributing.md file that helps people contribute
- [ ] Update main Mesa docs as well as contributing.md in the main mesa & mesa-geo repos to remove anything that might be confusing and also add whatever needs to be added for clarity.
- [ ] include stuff related to the outcome of discussion on pinning models - https://github.com/projectmesa/mesa/discussions/1530
- [ ] Add some text about writing a readme for an example should be formatted / what it should include

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing documentation in the mesa-examples repository and the related Mesa and mesa-geo documentation, then read the linked discussion on pinning models. Create CONTRIBUTING.md with contribution guidance, clarify the related documentation, and document the expected format and contents of example READMEs. Done means all acceptance criteria are addressed across the named repositories.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.