diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000000000000000000000000000000000..32fe1a2ad0eeec1cacf4ecb984f586e734625b6a --- /dev/null +++ b/.editorconfig @@ -0,0 +1,17 @@ +root = true + +[*] +end_of_line = lf +insert_final_newline = true +charset = utf-8 + +[*.{c,h}] +indent_style = tab +# tab_width = 4 + +[Makefile] +indent_style = tab + +[*.yml] +indent_style = space +indent_size = 2 diff --git a/.gitignore b/.gitignore index 250c79445271d4c9cf5b7f6df0a493eac7fc9788..1695c6f3ad16cb123374188938a97870065171a1 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,5 @@ log/src/munch.temp log/src/tooldir.c log/src/ana/logdef.h log/src/ana/log_action.h +/.vscode +/.idea diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000000000000000000000000000000..a56003740099ec074b184fc4a45f1a1be94f06b4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,88 @@ +# How to contribute + +## Code style + +Please conform to the rules in the [.editorconfig file](.editorconfig). See +[editorconfig website](https://editorconfig.org/) for more information on how +to use this file with your favorite editor. + +To be short, please use tabulation characters for indentation in C and header files. + +## Other rules + +* [ ] If you have an issue, please [open a ticket](https://git.iiens.net/brateau2015/diglog/issues) +* [ ] Please test your code by compiling and running unit tests before merging +* [ ] Ask for a review of your code by a peer +* [ ] Please rebase your branch on origin/master before merging (and squash merge). + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [INSERT EMAIL ADDRESS]. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org