Hey! I’m happy that you found us and are actually reading this! This document is to help newcomers to our project begin to make contributions and learn more about us!
First off, here are some important resources:
- To learn more about us the impac website tells you who we are
- Our blog talks about the status and goals of our project
- To get in contact with us, use the Mattermost Channel
- Checkout our code of conduct for some extra guidelines
- We are always looking for new eyes and machines to test our code and help us make our application as robust as possible.
- Please file all bugs under the issue tracker and include:
a) A description of the bug
b) How you produced this error
c) What you expected the output to be
d) Information about what device you produced this behavior on
- Our application is always looking to add new features and to improve our code base
- Please tells us about your idea in the feature request option under the issue tracker. Be sure to include:
a) Description of the new feature
b) What problem your feature is related to
c) Any specific suggestions on implementation or design
- We greatly appreciate those who take the time to fix our errors and improve our program. Be sure to review the submitting changes section below to ensure that we can incorporate your work into impac!
Please send a GitHub Pull Request with a description of what you've done (read pull requests for more info).
We also appreciate clear log messages for your commits. Quick notations are fine for small changes, but bigger changes should have a longer description:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
impac is currently using the C++ core set of coding guidelines.
We encourage you to pitch in and appreciate all contributions!
Thanks,
the impac team