Skip to content

Commit

Permalink
add contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
llaville committed Feb 20, 2022
1 parent 8a8aa39 commit 0b1e5ce
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- markdownlint-disable MD013 -->
# Contributing

Any kind of contribution is welcome.

Visit the forums

- for [announcements](https://github.com/llaville/box-manifest/discussions/categories/announcements) of new versions
- if you want to [ask a question or help others](https://github.com/llaville/box-manifest/discussions/categories/q-a)
- [learn](https://github.com/llaville/box-manifest/discussions/categories/show-and-tell) more about any features
- suggest new [ideas](https://github.com/llaville/box-manifest/discussions/categories/ideas)
- or any [other stuffs](https://github.com/llaville/box-manifest/discussions/categories/general)

## Getting Started with your PR

If you want to send a Pull Request, have these steps in mind :

- Create a new branch : `git checkout -b <my_new_tool>` (feel free to name your branch as you want)
- Adds your code, and writes as much as possible some unit tests
- Run Unit-Tests to avoid regression
- If it's a new feature, please consider writing documentation in Markdown format into the `docs` directory
- Send your Pull Request and wait for code review
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ markdown_extensions:
nav:
- "Home": index.md
- "Getting-Started": getting-started.md
- "Contributing": contributing.md

0 comments on commit 0b1e5ce

Please sign in to comment.