Skip to content

Commit

Permalink
fix(docs): 📝 Moved contributing guideness to main repo and fixed it's…
Browse files Browse the repository at this point in the history
… docs style
  • Loading branch information
SongshGeo committed Dec 19, 2024
1 parent dee5a21 commit 6601f3c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/home/contributing.md → contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In no particular order, examples include:
- Documentation improvements
- Tutorials

**submit a contribution**
**submit a contribution**

- Find or create something you want to work on
- Fork the ABSESpy repository
Expand All @@ -23,7 +23,7 @@ In no particular order, examples include:
- Add your change file or added file by git `git add FILE_NAME`
- Commit your changes with a message `git commit -m "Fix: DESCRIBE"`. The message should follow [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/)
- Make sure that your submission works with a few of the examples in the examples repository. And if implementing a new feature, include some documentation in docs folder.
- Check if your change passes the `pre-commit`.
- Check if your change passes the `pre-commit`.
- Push your change to your fork repository `git push origin BRANCH_NAME`
- Create a pull request and describe your change.

Expand All @@ -34,7 +34,7 @@ Maybe you are confused about where to start. It's OK! We provide some suggestion
### You are a modeller

You already know how to build ABM model and want to build your own model by ABSESpy. You want to improve that and contribute your idea as an example. Awesome!
Firstly you should get some tools and their knowledge. The code is based on `python` and manage the version by `git`.
Firstly you should get some tools and their knowledge. The code is based on `python` and manage the version by `git`.
After that, talk to us about what you want to change, and open a small PR. Or update the [example](https://github.com/ABSESpy/ABSESpy/tree/master/examples)

### You are a developer
Expand All @@ -44,11 +44,11 @@ In this case, learn something about ABM (agent based model). And you can run a m

### You are both

Wonderful! You can just start your work and read our workflow to prevent some error.
Wonderful! You can just start your work and read our workflow to prevent some error.

## Set environment

We recommend to set environment by `poetry`, you can also use `venv` or `conda` but it need some work done yourself.
We recommend to set environment by `poetry`, you can also use `venv` or `conda` but it need some work done yourself.

- `poetry` is a command tool that we recommend installing in a global environment by `pip install poetry`
- Enter your `ABSESpy` folder and create an environment for `poetry` by `poetry env use python`.
Expand Down Expand Up @@ -133,4 +133,4 @@ To create a new release, follow these steps:
[clone your repository]: https://help.github.com/articles/cloning-a-repository/
[create a pull request]: https://help.github.com/articles/creating-a-pull-request/
[license]: https://github.com/projectmesa/mesa/blob/main/LICENSE
[pre-commit]: https://github.com/pre-commit/pre-commit
[pre-commit]: https://github.com/pre-commit/pre-commit

0 comments on commit 6601f3c

Please sign in to comment.