mirror of https://github.com/aristocratos/bashtop
Added
parent
a236beeb1e
commit
fbe585f59a
|
@ -0,0 +1,76 @@
|
||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## 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 admin@qvantnet.com. 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
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see
|
||||||
|
https://www.contributor-covenant.org/faq
|
|
@ -0,0 +1,49 @@
|
||||||
|
# Contributing guidelines
|
||||||
|
|
||||||
|
## When submitting pull requests
|
||||||
|
|
||||||
|
* Explain your thinking in why a change or addition is needed.
|
||||||
|
* Is it a requested change or feature?
|
||||||
|
* If not, open a feature request to get feedback before making a pull request.
|
||||||
|
|
||||||
|
* Split up multiple unrelated changes in multiple pull requests.
|
||||||
|
|
||||||
|
* [Shellcheck](https://github.com/koalaman/shellcheck) your work. Current shellsheck exeptions at the beginning of [bashtop](bashtop).
|
||||||
|
|
||||||
|
* Purely cosmetic changes won't be accepted without a very good explanation of its value.
|
||||||
|
* (Some design choices are for better configurability of syntax highlighting.)
|
||||||
|
|
||||||
|
## Formatting
|
||||||
|
|
||||||
|
### Follow the current syntax design
|
||||||
|
|
||||||
|
* Indent type: Tabs
|
||||||
|
|
||||||
|
* Tab size: 4
|
||||||
|
|
||||||
|
* Use the longer "if, elif, then, else, fi" statements and indent conditionals, loops etc.
|
||||||
|
|
||||||
|
* Use "[[ ]]", "(( ))" for conditions and "$( ), <( )" for command substitution.
|
||||||
|
|
||||||
|
* Create functions instead of repeating blocks of code.
|
||||||
|
|
||||||
|
* Don't stack unrelated blocks of code, leave blank lines for better readability.
|
||||||
|
|
||||||
|
* Comment new code that isn't very obvious in it's function.
|
||||||
|
|
||||||
|
* Name new variables and functions in lower-case and after what purpose they serve.
|
||||||
|
* (Exception arithmetic with many variables, make sure to comment what's happening instead.)
|
||||||
|
|
||||||
|
## Optimization
|
||||||
|
|
||||||
|
* Avoid forks if possible.
|
||||||
|
|
||||||
|
* Avoid writing to disk if possible.
|
||||||
|
|
||||||
|
* Make sure variables/arrays are cleaned up if not reused.
|
||||||
|
|
||||||
|
* Compare cpu and memory usage with and without your code and look for alternatives if they cause a noticeable negative impact.
|
||||||
|
|
||||||
|
For questions contact Aristocratos at admin@qvantnet.com
|
||||||
|
|
||||||
|
For proposing changes to this document create a [new issue](https://github.com/aristocratos/bashtop/issues/new/choose).
|
Loading…
Reference in New Issue