Skip to content

Commit 1a5eb0a

Browse files
authored
Update CONTRIBUTING.md
1 parent 563ac45 commit 1a5eb0a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

CONTRIBUTING.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,13 @@ This project and everyone participating in it is governed by the [Zep Code of Co
1515

1616
## How Can I Contribute?
1717

18-
This document is incomplete, but either report an issue or send a pull request! In your pull request, add the following comment:
18+
Either report an issue or send a pull request!
1919

20-
`@all-contributors please add @your-user-name for code`
20+
Instructions for building are on the main page. Make sure you at least build the demo and play with it, and run the unit tests - instructions on the main page also.
21+
The CI, on the 'Actions' tab builds on all 3 platforms, along with running unit tests. If you are stuck on build issues, consult the scripts in the .github/workflows folder to see how the application is built.
2122

23+
In your pull request, add the following comment:
24+
`@all-contributors please add @your-user-name for code`
2225
This will add you to the list of the contributors on the readme page, once your PR is accepted. You can also use 'docs', 'tests', etc. depending on your contribution.
2326

2427

0 commit comments

Comments
 (0)