From d12695df688a6276f59a970a5329e23587ead61d Mon Sep 17 00:00:00 2001 From: Francesco Rombaldoni Date: Thu, 9 May 2024 11:22:28 +0200 Subject: [PATCH] Update for codacy --- .markdownlint.json | 4 ++++ CODE_OF_CONDUCT.md | 46 ++++++++++++++++++++-------------------- CONTRIBUTING.md | 52 +++++++++++++++++++++++++--------------------- 3 files changed, 56 insertions(+), 46 deletions(-) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..0ab2b0d --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,4 @@ +{ + "MD043": false, + "MD026": false +} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index b019782..b16d0d4 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -7,41 +7,41 @@ 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, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, -religion, or sexual identity and orientation. +religion, or sexual identity and orientation. ## Our Standards Examples of behavior that contributes to creating a positive environment -include: +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 +* 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: +Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or +* 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 +* 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 +* 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. +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. +threatening, offensive, or harmful. ## Scope @@ -50,24 +50,26 @@ 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. +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 f.rombaldoni@campus.uniurb.it. All +reported by contacting the project team at . 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. +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. +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 +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, +available at + -[homepage]: https://www.contributor-covenant.org +[homepage]: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f63822f..1852e03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,52 +1,56 @@ -Contributing -============ +# Contributing 👍🎉 Thanks a lot for considering contributing 🎉👍 We welcome and encourage contribution. There is many way to contribute: you can write bug report, contribute code or documentation. -Working on your first Pull Request? ------------------------------------ +## Working on your first Pull Request? -You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) +You can learn how from this *free* series + [How to Contribute to an Open Source Project on GitHub] +() -Reporting issues ----------------- +## Reporting issues When reporting issues the more information you can supply the better. -If it is an issue with building the LaTeX package, indicate your environment like operating system and, -version of MikTeX your are using. +If it is an issue with building the LaTeX package, indicate your + environment like operating system and, + version of MikTeX your are using. -Improvements request and proposal ---------------------------------- +## Improvements request and proposal Feel free to make an issue to request a new functionality. -Contributing code/Pull-Request ------------------------------- +## Contributing code/Pull-Request We welcome contribution, this can be done by starting a pull-request. -You can contribute by updating the package content or styling, code (.cls file), or both. +You can contribute by updating the package content or styling, code ( +.cls file), or both. ### Contributing content or styling There is a couple of basic requirement for us to merge the pull request: -- The styling should maintain the compatibility with previous versions. For example, if you plan to - add a new number to the contact information, it should be optional and not mandatory allowing not to - change anything to the other users of the package. + +- The styling should maintain the compatibility with previous versions. + For example, if you plan to add a new number to the contact information, + it should be optional and not mandatory allowing not to change anything + to the other users of the package. ### Contributing code -If the change is big, typically if the change span to more than one file, consider starting an issue first to discuss the improvement. -This will makes it much easier to make the change fit well into the package. +If the change is big, typically if the change span to more than one file, + consider starting an issue first to discuss the improvement. + This will makes it much easier to make the change fit well into the package. There is some basic requirement for us to merge a pull request: -- Describe the change -- Refer to any issues it effects -- Separate one pull request per functionality: if you start writing "and" in the feature description consider if it could be - separated in two pull requests. + +- Describe the change +- Refer to any issues it effects +- Separate one pull request per functionality: if you start writing "and" + in the feature description consider if it could be separated in two pull requests. In your code: -- Make sure the coding style of your code follows the style of the file. + +- Make sure the coding style of your code follows the style of the file.