From 84307c42eb8bc25e8f77144c626ecfc4836fd737 Mon Sep 17 00:00:00 2001 From: Thomas von Dein Date: Thu, 16 Oct 2025 12:50:22 +0200 Subject: [PATCH] added contrib and minimal technical coc --- CODE_OF_CONDUCT.md | 18 +++++++++ CONTRIBUTING.md | 94 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 112 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ea92e68 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,18 @@ +# CODE_OF_CONDUCT.md (compact model) + +Purpose: Maintain a collaborative, harassment-free environment focused +on shipping quality software. + +Standards: Be respectful; assume good intent; no harassment; no +discrimination; keep critiques technical. + +Scope: All project spaces (issues, PRs, forums, events). + +Reporting: Email tom AT vondein DOT org. Acknowledge within 72 hours. + +Enforcement: Two maintainers review, one recuses on +conflict. Sanctions range from warning to removal. Summary posted (no +personal details). + +Escalation: If you believe maintainers handled a report in bad faith, +escalate to our foundation committee (link) for independent review. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..49be6d9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,94 @@ +## Project Goals + +The goal of this project is to build a small tool which helps in day +to day work with tabular output of various commandline programs. It +should be small, fast and easy to understand. The idea is to replace +multiline shell pipes using awk, sed and grep with just one +binary. + +There will be no GUI, no web interface, no public API of some sort, no +builtin interpreter. + +The programming language used for this project will always be +[GOLANG](https://go.dev/) with the exception of the documentation +([Perl POD](https://perldoc.perl.org/perlpod)) and the Makefile. + +# Contributing + +You can contribute to this project in various ways: + +## Open an issue + +If you encounter a problem or don't understand how the program works +or if you think the documentation is unclear, please don't hesitate to +open an issue. + +Please add as much information about the case as possible, such as: + +- Your environment (operating system etc) +- program version +- Input data. Please replace sensitive information with mock data! +- Actual program output. +- Expected program output. +- Error message - if any. + +Be aware that I am working on this (and some other) project in my +spare time which is scarce. Therefore please don't expect me to +respond to your query within hours or even days. Be patient, but I +WILL respond. + +## Pull Requests + +Code and documentation help is always much appreciated! Please follow +thes guidelines to successfully contribute: + +- Every pull request shall be based on latest `development` + branch. `main` is only used for releases. + +- Execute the unit tests before committing: `make test`. There shall + be no errors. + +- Strive to be backwards compatible so that users who are already + using the program don't have to change their habits - unless it is + really neccessary. + +- Try to add a unit test for your addition. + +- Don't ever change existing unit tests! + +- Add a meaningful and comprehensive rationale about your contribution: + - Why do you think it might be useful for others? + - What did you actually change or add? + - Is there an open issue which this PR fixes and if so, please link + to that issue. + +- [Re-]format your code with `gofmt -s`. + +- Avoid unneccesary dependencies, especially for very small functions. + +- **If** a new dependency is being added, it must be compatible with + our [license agreement](LICENSE). + +- You need to accept that the code or documentation you contribute + will be redistributed under the terms of said license agreement. If + your contribution is considerably large or if you contribute + regularly, then feel free to add your name and if you want your + email address to the *AUTHORS* section of the + manual page. + +- Adhere to the above mentioned project goals. + +- If you are unsure if your addition or change will be accepted, + better ask before starting coding. Open an issue about your proposal + and let's discuss it! That way we avoid doing unnessesary work on + both sides. + +Each pull request will be carefully reviewed and if it is a useful +addition it will be accepted. However, please be prepared that +sometimes a PR will be rejected. The reasons may vary and will be +documented. Perhaps the above guidelines are not matched, or the +addition seems to be not so useful from my perspective, maybe there +are too much changes or there might be changes I don't even +understand. + +But whatever happens: your contribution is always welcome!