Community Guidelines - krishanth7/EveryO GitHub Wiki
Build Together · Share Knowledge · Respect Everyone · Advance Open Computing
A collaborative, respectful, technically rigorous environment for developers, researchers, students, maintainers, and open-source contributors.
Home · Contributing · Project Governance · Support and Troubleshooting
Project: EveryO
Maintainer: @krishanth7
Community Platform: GitHub
Important
Policy Authority
The authoritative community rules are maintained in the repository's Code of Conduct, Repository Rules, and Governance Policy.
This Wiki page explains those expectations in an accessible format and provides recommended collaboration practices. Where any wording differs, the repository policies take precedence.
- Community Overview
- Our Mission
- Community Principles
- Who Can Participate
- Expected Conduct
- Unacceptable Conduct
- Professional Communication
- GitHub Discussions Guidelines
- Issue Reporting Guidelines
- Pull Request Collaboration
- Code Review Etiquette
- Technical Disagreements
- Community Decision-Making
- Contributor Recognition
- New Contributor Onboarding
- Documentation Contributions
- Responsible AI Development
- Security and Responsible Disclosure
- Privacy and Confidentiality
- Spam and Promotional Content
- Community Moderation
- Reporting Community Concerns
- Maintainer Responsibilities
- Community Events and Initiatives
- Recommended Community Workflow
- Community FAQ
- Official Resources
- Final Community Commitment
EveryO is an open-source neural computing framework developed to make machine learning systems more understandable, accessible, and verifiable.
The community plays an important role in improving the framework through:
- Software development.
- Technical discussions.
- Research.
- Documentation.
- Testing.
- Bug reporting.
- Code review.
- Knowledge sharing.
Community participation should be constructive, transparent, and aligned with the project's technical objectives.
The EveryO community aims to:
- Encourage meaningful open-source collaboration.
- Maintain a respectful technical environment.
- Improve framework correctness.
- Support learning and experimentation.
- Promote reproducible research.
- Recognize useful contributions.
- Protect users and contributors.
- Maintain sustainable project governance.
These guidelines apply to participation in project-managed spaces, including:
- GitHub Issues.
- Pull Requests.
- Discussions.
- Code reviews.
- Documentation collaboration.
- Other official community spaces, if established.
Build an open environment where people can understand, improve, and experiment with neural computing technologies.
EveryO prioritizes:
- Readable implementations.
- Correct mathematical behavior.
- Transparent numerical operations.
- Reproducible experiments.
- Accessible documentation.
- Responsible engineering.
EVERYO COMMUNITY
|
+-----------+-----------+
| | |
v v v
LEARN BUILD SHARE
| | |
+-----------+-----------+
|
v
REVIEW
|
v
IMPROVE
|
v
OPEN INNOVATION
Treat participants with dignity and professionalism.
Disagreement about code or technical decisions must not become personal hostility.
Welcome participants with different backgrounds, experiences, and skill levels.
Explain technical decisions and limitations accurately.
Work toward solutions that improve the project rather than individual recognition alone.
Take responsibility for submitted changes and correct mistakes when identified.
Do not fabricate:
- Benchmarks.
- Test results.
- Research findings.
- Implementation status.
- Security claims.
Prefer maintainable solutions over unnecessary complexity.
The EveryO community welcomes:
| Participant | Typical Contributions |
|---|---|
| Students | Learning, documentation, testing |
| Developers | Features, bug fixes, reviews |
| Researchers | Numerical experiments, validation |
| Educators | Tutorials, educational resources |
| Engineers | Performance, compatibility, tooling |
| Maintainers | Reviews, releases, governance |
| Users | Feedback, bug reports, questions |
There is no general experience threshold for participating in discussions or submitting contributions.
First-time contributors are encouraged to begin with:
- Documentation improvements.
- Reproducible bug reports.
- Small tests.
- Focused fixes.
All participants must follow the applicable repository policies.
The project's Code of Conduct establishes expectations for respectful and constructive participation.
Examples include:
- Using welcoming language.
- Respecting differing viewpoints.
- Accepting constructive feedback.
- Demonstrating empathy.
- Focusing on the project's goals.
- Giving credit for contributions.
Contributors should:
- Explain changes clearly.
- Provide evidence for technical claims.
- Respond constructively to reviews.
- Avoid unnecessary personal criticism.
- Respect maintainers' decisions.
- Correct inaccurate information.
Prefer:
The current implementation fails this numerical test because the gradient is not reduced over the broadcast dimension.
Avoid:
This code is terrible and the author does not understand autograd.
Focus criticism on observable technical behavior.
The Code of Conduct and Repository Rules prohibit behavior that undermines safety, trust, or constructive collaboration.
- Harassment.
- Discrimination.
- Threats.
- Personal attacks.
- Trolling.
- Repeated disruption.
- Doxxing.
- Publishing private information.
- Unwanted sexual attention.
- Spam.
- Deceptive promotion.
Unacceptable repository activity includes:
- Malicious code.
- Credential harvesting.
- Undisclosed network activity.
- Unauthorized telemetry.
- Fabricated test results.
- Misleading benchmarks.
- Incompatible licensing.
- Unreviewed bulk changes presented as verified.
- Repeated duplicate issues or pull requests.
Violations may result in moderation actions under the official Code of Conduct.
Use descriptive titles and explain the problem before proposing a solution.
Include:
- Relevant source files.
- Reproduction steps.
- Expected behavior.
- Actual behavior.
- Technical evidence.
When disagreeing, provide a technical explanation and, where possible, an alternative.
Do not assume another contributor's intent or experience.
| Situation | Recommended Response |
|---|---|
| Bug identified | Explain reproduction and expected behavior |
| Review requested | Provide specific technical feedback |
| Proposal rejected | Ask about constraints and alternatives |
| Test failed | Share output and isolate the failure |
| Contributor needs help | Point to relevant documentation |
GitHub Discussions is the recommended location for general community questions and broader technical conversations.
- Framework usage.
- Design proposals.
- Architecture questions.
- Educational discussions.
- Research ideas.
- Community feedback.
- Search existing discussions.
- Review relevant documentation.
- Choose an appropriate category.
- Write a descriptive title.
- Provide sufficient context.
# Discussion: Topic
## Background
Explain the context.
## Question or Proposal
Describe the main topic.
## Technical Details
Provide relevant information.
## Alternatives Considered
List possible approaches.
## Expected Outcome
Explain what feedback or decision is needed.Keep discussions relevant to EveryO and its technical community.
GitHub Issues should be used for actionable, reproducible problems and tracked improvements.
- Search for duplicates.
- Confirm the problem is reproducible.
- Check the documentation.
- Collect relevant environment information.
- Use the appropriate template.
Include:
- EveryO version.
- Python version.
- Operating system.
- Reproduction code.
- Expected behavior.
- Actual behavior.
- Error output.
Include:
- Problem statement.
- Proposed solution.
- Intended users.
- Alternatives.
- Compatibility implications.
- Testing requirements.
Avoid:
- Duplicate issues.
- Vague descriptions.
- Unsupported claims.
- Unrelated feature requests.
- Spam.
Pull requests are the primary mechanism for proposing source changes.
Identify Improvement
|
v
Open Discussion
(if necessary)
|
v
Create Branch
|
v
Implement Change
|
v
Run Tests
|
v
Open Pull Request
|
v
Code Review
|
v
Revise If Necessary
|
v
Maintainer Decision
A pull request should:
- Have a clear purpose.
- Remain focused.
- Include relevant tests.
- Preserve supported behavior.
- Update documentation when needed.
- Follow coding standards.
Changes to differentiable operations should include appropriate gradient verification.
Contributions should preserve the CPU-only baseline unless a deliberate architectural change has been approved.
Passing CI does not guarantee acceptance.
Code reviews should improve quality without discouraging contributors.
Reviewers should:
- Understand the proposed change.
- Check correctness.
- Evaluate test coverage.
- Identify compatibility risks.
- Explain requested changes.
- Avoid unnecessary personal criticism.
Contributors should:
- Read review comments carefully.
- Ask for clarification when needed.
- Address relevant concerns.
- Explain technical trade-offs.
- Avoid dismissive responses.
| Category | Meaning |
|---|---|
| Correctness | Does the implementation behave as intended? |
| Numerical Accuracy | Are mathematical results reliable? |
| Compatibility | Does it preserve supported behavior? |
| Performance | Are costs understood and measured? |
| Security | Does it introduce new risks? |
| Maintainability | Can the code be understood and maintained? |
| Documentation | Are usage and limitations explained? |
The new operation appears correct for equal-shaped inputs, but broadcasting cases need finite-difference gradient tests before merging.
Technical disagreements are normal in open-source development.
- Define the disputed behavior.
- Identify project requirements.
- Present evidence.
- Compare alternatives.
- Discuss trade-offs.
- Seek a practical resolution.
- Respect the final governance decision.
Useful evidence includes:
- Reproducible tests.
- Benchmarks.
- Numerical comparisons.
- Documentation.
- Compatibility analysis.
Do not interpret disagreement with a proposal as a personal rejection.
Unresolved architectural disagreements may be referred to the project maintainer.
EveryO follows a maintainer-led governance model.
The maintainer is responsible for:
- Technical direction.
- Release decisions.
- Contribution acceptance.
- Repository management.
- Policy enforcement.
Community feedback is welcome through issues, discussions, and pull requests.
Decisions may consider:
- Correctness.
- Maintainability.
- Security.
- Compatibility.
- Project scope.
- Available maintenance capacity.
The maintainer retains final authority under the official governance policy.
Contributions do not automatically grant elevated repository permissions.
EveryO values meaningful contributions.
Recognition may include:
- Code contributions.
- Documentation.
- Tests.
- Reviews.
- Bug reports.
- Technical discussions.
Contributors should receive accurate credit for their work.
Git supports co-author attribution in commits.
Example:
Co-authored-by: Contributor Name <[email protected]>
Only use co-author attribution with the contributor's permission and for genuine contributions.
- Do not fabricate contributions.
- Do not manipulate contribution statistics.
- Do not create artificial pull requests for recognition.
- Do not claim authorship of another person's work.
Contributor spotlights or recognition initiatives may be proposed, but are not established by this document.
Review:
README.mdCONTRIBUTING.mdCODE_OF_CONDUCT.mdREPOSITORY_RULES.mdGOVERNANCE.md
git clone https://github.com/krishanth7/EveryO.git
cd EveryO
python -m venv .venvActivate the virtual environment.
Then install development dependencies:
python -m pip install -e ".[dev]"python -m pytest -qruff check .
ruff format --check .Choose a focused issue matching your experience.
Describe the change and provide testing evidence.
Documentation is an important part of EveryO.
- Correcting inaccurate explanations.
- Improving installation instructions.
- Adding runnable examples.
- Clarifying API behavior.
- Documenting limitations.
- Fixing broken links.
Documentation should be:
- Accurate.
- Clear.
- Consistent.
- Accessible.
- Technically reproducible.
Examples should use real EveryO APIs.
Avoid:
- Invented functions.
- Unsupported parameters.
- Fabricated output.
- Unverified benchmark claims.
Wiki improvements should be reviewed against the repository's source code and official documentation.
EveryO is a neural computing framework, and its community should promote responsible experimentation.
Contributors should report:
- Experimental setup.
- Data assumptions.
- Evaluation methods.
- Limitations.
- Reproducibility constraints.
Use datasets in accordance with their licenses and applicable privacy requirements.
Avoid claiming perfect accuracy or universal model performance without evidence.
Provide:
- Seeds.
- Software versions.
- Dataset details.
- Hyperparameters.
- Evaluation procedures.
Do not introduce malicious behavior, credential harvesting, or unauthorized data transmission.
Clearly distinguish experimental results from established functionality.
Security issues require special handling.
Use:
GitHub Private Vulnerability Reporting
Do not post:
- Exploit details.
- Sensitive attack instructions.
- Confidential vulnerability reports.
- Private credentials.
Provide:
- Affected component.
- Relevant version.
- Reproduction steps.
- Security impact.
- Suggested mitigation, if available.
Refer to:
Do not publish another person's private information without authorization.
Never commit:
- Passwords.
- API tokens.
- Private keys.
- Access credentials.
Do not upload confidential datasets or internal company information to public issues.
Remove sensitive information before sharing logs.
Contributors should understand the privacy implications of any new external integration.
The repository rules prohibit spam and deceptive promotional activity.
- Repeated duplicate issues.
- Irrelevant advertising.
- Automated promotional comments.
- Artificial contribution activity.
- Misleading project endorsements.
A link to another project may be useful when it directly supports a technical discussion.
A genuine technical contribution should provide demonstrable value to EveryO.
Do not manipulate stars, issues, pull requests, or review activity to create a misleading impression of popularity.
Moderation helps maintain a safe and productive environment.
- Protect participants.
- Enforce community standards.
- Prevent disruption.
- Maintain technical discussion quality.
Depending on the circumstances and the official Code of Conduct, maintainers may:
- Request changes in behavior.
- Remove inappropriate content.
- Restrict participation.
- Temporarily or permanently ban participants.
Moderation decisions should consider severity, context, and repeated behavior.
Sensitive reports should be handled with appropriate confidentiality.
The official Code of Conduct defines the enforcement framework.
Use the reporting mechanism identified in the repository's Code of Conduct.
Use private vulnerability reporting.
Use GitHub Issues.
Use GitHub Discussions.
Include relevant context while avoiding unnecessary disclosure of private information.
Maintainers play a central role in community health.
- Review contributions.
- Maintain repository quality.
- Manage releases.
- Evaluate architectural changes.
- Preserve project consistency.
- Apply policies consistently.
- Encourage constructive discussion.
- Respond to concerns appropriately.
- Communicate technical decisions clearly.
Where appropriate, maintainers should explain significant technical decisions.
Maintainers are not required to accept every contribution or provide unlimited support.
Refer to:
The following are potential community initiatives rather than confirmed existing programs.
- Beginner contribution sessions.
- Documentation improvement drives.
- Numerical correctness workshops.
- Open-source mentoring.
- Architecture discussions.
- Testing and benchmarking events.
Community activities should be:
- Inclusive.
- Technically meaningful.
- Voluntary.
- Respectful.
- Transparent.
Any proposed event should identify organizers, scope, dates, and participation requirements before being announced.
COMMUNITY MEMBER
|
v
Explore Repository
|
v
Read Policies
|
v
Identify a Need
|
+---------+---------+
| |
v v
Question Code Change
| |
v v
Discussion Issue / PR
| |
+---------+---------+
|
v
Technical Review
|
v
Resolution
|
v
Shared Knowledge
Healthy collaboration is measured through:
- Useful contributions.
- Reproducible results.
- Clear documentation.
- Respectful reviews.
- Sustainable maintenance.
Raw activity counts alone are not sufficient indicators of project quality.
Can beginners contribute to EveryO?
Yes. Beginners can contribute documentation, tests, bug reports, and small improvements.
Can I propose a new feature?
Yes. Open a feature request or discussion with a clear problem statement and technical rationale.
Can I submit a pull request without opening an issue?
Small, focused changes may be proposed directly. Larger architectural changes should be discussed first.
Does passing CI guarantee merge approval?
No. Maintainer review and project requirements also apply.
Can I become a maintainer?
Contributions do not automatically grant maintainer permissions. Any changes to project roles are governed by the maintainer.
Can I use AI tools while contributing?
AI-assisted work must still satisfy the project's quality, review, attribution, and integrity requirements. Contributors remain responsible for verifying submitted changes.
Can I promote my own project?
Only when the reference is directly relevant to a technical discussion and complies with repository rules. Unrelated promotion and spam are not allowed.
Where should I report harassment?
Follow the reporting instructions in CODE_OF_CONDUCT.md.
Where should I report a security vulnerability?
Use GitHub Private Vulnerability Reporting.
Who makes final project decisions?
The project maintainer has final decision-making authority under GOVERNANCE.md.
| Resource | Link |
|---|---|
| Repository | EveryO |
| Code of Conduct | CODE_OF_CONDUCT.md |
| Repository Rules | REPOSITORY_RULES.md |
| Contributing | CONTRIBUTING.md |
| Governance | GOVERNANCE.md |
| Project Policy | PROJECT_POLICY.md |
| Security | SECURITY.md |
| Support | SUPPORT.md |
| Issues | GitHub Issues |
| Pull Requests | GitHub Pull Requests |
| Discussions | GitHub Discussions |
| Maintainer | @krishanth7 |
The EveryO community is built on open collaboration, technical integrity, and mutual respect.
Every contribution should help improve the framework or the experience of its users and contributors.
Our shared objectives are to:
- Build reliable neural computing software.
- Encourage learning and experimentation.
- Maintain transparent technical practices.
- Respect contributors and users.
- Protect the integrity of the project.
- Support sustainable open-source development.
Great open-source software is built through careful engineering and meaningful collaboration.
Next Recommended Page: Acknowledgements →
Home · Contributing · Project Governance
EveryO — Open Machine Learning. Built for Developers.
Project Maintainer: @krishanth7
Open Source · MIT Licensed · Community Driven
© 2026 EveryO Contributors