Community Guidelines - krishanth7/EveryO GitHub Wiki

Community Guidelines

EveryO — Open Source Community & Collaboration Standards

Build Together · Share Knowledge · Respect Everyone · Advance Open Computing

Community Code of Conduct Contributions License

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.


Table of Contents

  1. Community Overview
  2. Our Mission
  3. Community Principles
  4. Who Can Participate
  5. Expected Conduct
  6. Unacceptable Conduct
  7. Professional Communication
  8. GitHub Discussions Guidelines
  9. Issue Reporting Guidelines
  10. Pull Request Collaboration
  11. Code Review Etiquette
  12. Technical Disagreements
  13. Community Decision-Making
  14. Contributor Recognition
  15. New Contributor Onboarding
  16. Documentation Contributions
  17. Responsible AI Development
  18. Security and Responsible Disclosure
  19. Privacy and Confidentiality
  20. Spam and Promotional Content
  21. Community Moderation
  22. Reporting Community Concerns
  23. Maintainer Responsibilities
  24. Community Events and Initiatives
  25. Recommended Community Workflow
  26. Community FAQ
  27. Official Resources
  28. Final Community Commitment

1. Community Overview

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.

1.1 Community Objectives

The EveryO community aims to:

  1. Encourage meaningful open-source collaboration.
  2. Maintain a respectful technical environment.
  3. Improve framework correctness.
  4. Support learning and experimentation.
  5. Promote reproducible research.
  6. Recognize useful contributions.
  7. Protect users and contributors.
  8. Maintain sustainable project governance.

1.2 Scope

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.

2. Our Mission

2.1 Community Mission

Build an open environment where people can understand, improve, and experiment with neural computing technologies.

2.2 Technical Mission

EveryO prioritizes:

  • Readable implementations.
  • Correct mathematical behavior.
  • Transparent numerical operations.
  • Reproducible experiments.
  • Accessible documentation.
  • Responsible engineering.

2.3 Community Philosophy

             EVERYO COMMUNITY
                    |
        +-----------+-----------+
        |           |           |
        v           v           v
      LEARN       BUILD       SHARE
        |           |           |
        +-----------+-----------+
                    |
                    v
                 REVIEW
                    |
                    v
                 IMPROVE
                    |
                    v
             OPEN INNOVATION

3. Community Principles

3.1 Respect

Treat participants with dignity and professionalism.

Disagreement about code or technical decisions must not become personal hostility.

3.2 Inclusion

Welcome participants with different backgrounds, experiences, and skill levels.

3.3 Transparency

Explain technical decisions and limitations accurately.

3.4 Collaboration

Work toward solutions that improve the project rather than individual recognition alone.

3.5 Accountability

Take responsibility for submitted changes and correct mistakes when identified.

3.6 Technical Integrity

Do not fabricate:

  • Benchmarks.
  • Test results.
  • Research findings.
  • Implementation status.
  • Security claims.

3.7 Sustainability

Prefer maintainable solutions over unnecessary complexity.


4. Who Can Participate

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

4.1 Experience Requirements

There is no general experience threshold for participating in discussions or submitting contributions.

4.2 First-Time Contributors

First-time contributors are encouraged to begin with:

  • Documentation improvements.
  • Reproducible bug reports.
  • Small tests.
  • Focused fixes.

4.3 Participation Expectations

All participants must follow the applicable repository policies.


5. Expected Conduct

The project's Code of Conduct establishes expectations for respectful and constructive participation.

5.1 Positive Behavior

Examples include:

  • Using welcoming language.
  • Respecting differing viewpoints.
  • Accepting constructive feedback.
  • Demonstrating empathy.
  • Focusing on the project's goals.
  • Giving credit for contributions.

5.2 Professional Collaboration

Contributors should:

  1. Explain changes clearly.
  2. Provide evidence for technical claims.
  3. Respond constructively to reviews.
  4. Avoid unnecessary personal criticism.
  5. Respect maintainers' decisions.
  6. Correct inaccurate information.

5.3 Technical Communication

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.


6. Unacceptable Conduct

The Code of Conduct and Repository Rules prohibit behavior that undermines safety, trust, or constructive collaboration.

6.1 Examples

  • Harassment.
  • Discrimination.
  • Threats.
  • Personal attacks.
  • Trolling.
  • Repeated disruption.
  • Doxxing.
  • Publishing private information.
  • Unwanted sexual attention.
  • Spam.
  • Deceptive promotion.

6.2 Technical Misconduct

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.

6.3 Consequences

Violations may result in moderation actions under the official Code of Conduct.


7. Professional Communication

7.1 Be Clear

Use descriptive titles and explain the problem before proposing a solution.

7.2 Be Specific

Include:

  • Relevant source files.
  • Reproduction steps.
  • Expected behavior.
  • Actual behavior.
  • Technical evidence.

7.3 Be Constructive

When disagreeing, provide a technical explanation and, where possible, an alternative.

7.4 Avoid Assumptions

Do not assume another contributor's intent or experience.

7.5 Communication Examples

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

8. GitHub Discussions Guidelines

GitHub Discussions is the recommended location for general community questions and broader technical conversations.

Open Discussions

8.1 Appropriate Topics

  • Framework usage.
  • Design proposals.
  • Architecture questions.
  • Educational discussions.
  • Research ideas.
  • Community feedback.

8.2 Before Posting

  1. Search existing discussions.
  2. Review relevant documentation.
  3. Choose an appropriate category.
  4. Write a descriptive title.
  5. Provide sufficient context.

8.3 Recommended Discussion Format

# 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.

8.4 Discussion Quality

Keep discussions relevant to EveryO and its technical community.


9. Issue Reporting Guidelines

GitHub Issues should be used for actionable, reproducible problems and tracked improvements.

Open Issues

9.1 Before Creating an Issue

  • Search for duplicates.
  • Confirm the problem is reproducible.
  • Check the documentation.
  • Collect relevant environment information.
  • Use the appropriate template.

9.2 Bug Reports

Include:

  • EveryO version.
  • Python version.
  • Operating system.
  • Reproduction code.
  • Expected behavior.
  • Actual behavior.
  • Error output.

9.3 Feature Requests

Include:

  • Problem statement.
  • Proposed solution.
  • Intended users.
  • Alternatives.
  • Compatibility implications.
  • Testing requirements.

9.4 Issue Quality

Avoid:

  • Duplicate issues.
  • Vague descriptions.
  • Unsupported claims.
  • Unrelated feature requests.
  • Spam.

10. Pull Request Collaboration

Pull requests are the primary mechanism for proposing source changes.

10.1 Recommended Workflow

       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

10.2 Pull Request Expectations

A pull request should:

  • Have a clear purpose.
  • Remain focused.
  • Include relevant tests.
  • Preserve supported behavior.
  • Update documentation when needed.
  • Follow coding standards.

10.3 Numerical Changes

Changes to differentiable operations should include appropriate gradient verification.

10.4 Optional Backends

Contributions should preserve the CPU-only baseline unless a deliberate architectural change has been approved.

10.5 Review Outcome

Passing CI does not guarantee acceptance.


11. Code Review Etiquette

Code reviews should improve quality without discouraging contributors.

11.1 Reviewer Responsibilities

Reviewers should:

  1. Understand the proposed change.
  2. Check correctness.
  3. Evaluate test coverage.
  4. Identify compatibility risks.
  5. Explain requested changes.
  6. Avoid unnecessary personal criticism.

11.2 Contributor Responsibilities

Contributors should:

  1. Read review comments carefully.
  2. Ask for clarification when needed.
  3. Address relevant concerns.
  4. Explain technical trade-offs.
  5. Avoid dismissive responses.

11.3 Review Categories

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?

11.4 Constructive Review Example

The new operation appears correct for equal-shaped inputs, but broadcasting cases need finite-difference gradient tests before merging.


12. Technical Disagreements

Technical disagreements are normal in open-source development.

12.1 Recommended Resolution Process

  1. Define the disputed behavior.
  2. Identify project requirements.
  3. Present evidence.
  4. Compare alternatives.
  5. Discuss trade-offs.
  6. Seek a practical resolution.
  7. Respect the final governance decision.

12.2 Evidence-Based Discussion

Useful evidence includes:

  • Reproducible tests.
  • Benchmarks.
  • Numerical comparisons.
  • Documentation.
  • Compatibility analysis.

12.3 Avoid Personal Conflict

Do not interpret disagreement with a proposal as a personal rejection.

12.4 Escalation

Unresolved architectural disagreements may be referred to the project maintainer.


13. Community Decision-Making

EveryO follows a maintainer-led governance model.

13.1 Maintainer Authority

The maintainer is responsible for:

  • Technical direction.
  • Release decisions.
  • Contribution acceptance.
  • Repository management.
  • Policy enforcement.

13.2 Community Input

Community feedback is welcome through issues, discussions, and pull requests.

13.3 Decision Criteria

Decisions may consider:

  • Correctness.
  • Maintainability.
  • Security.
  • Compatibility.
  • Project scope.
  • Available maintenance capacity.

13.4 Final Decisions

The maintainer retains final authority under the official governance policy.

13.5 Contributor Permissions

Contributions do not automatically grant elevated repository permissions.


14. Contributor Recognition

EveryO values meaningful contributions.

14.1 Contribution Types

Recognition may include:

  • Code contributions.
  • Documentation.
  • Tests.
  • Reviews.
  • Bug reports.
  • Technical discussions.

14.2 Attribution

Contributors should receive accurate credit for their work.

14.3 Co-Authorship

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.

14.4 Recognition Principles

  • 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.

14.5 Future Recognition Programs

Contributor spotlights or recognition initiatives may be proposed, but are not established by this document.


15. New Contributor Onboarding

15.1 Step 1 — Explore the Repository

EveryO on GitHub

15.2 Step 2 — Read the Policies

Review:

  • README.md
  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md
  • REPOSITORY_RULES.md
  • GOVERNANCE.md

15.3 Step 3 — Set Up Development

git clone https://github.com/krishanth7/EveryO.git

cd EveryO

python -m venv .venv

Activate the virtual environment.

Then install development dependencies:

python -m pip install -e ".[dev]"

15.4 Step 4 — Run Tests

python -m pytest -q

15.5 Step 5 — Run Code Quality Checks

ruff check .

ruff format --check .

15.6 Step 6 — Select an Issue

Choose a focused issue matching your experience.

15.7 Step 7 — Submit a Pull Request

Describe the change and provide testing evidence.


16. Documentation Contributions

Documentation is an important part of EveryO.

16.1 Useful Contributions

  • Correcting inaccurate explanations.
  • Improving installation instructions.
  • Adding runnable examples.
  • Clarifying API behavior.
  • Documenting limitations.
  • Fixing broken links.

16.2 Documentation Standards

Documentation should be:

  • Accurate.
  • Clear.
  • Consistent.
  • Accessible.
  • Technically reproducible.

16.3 Code Examples

Examples should use real EveryO APIs.

Avoid:

  • Invented functions.
  • Unsupported parameters.
  • Fabricated output.
  • Unverified benchmark claims.

16.4 Wiki Contributions

Wiki improvements should be reviewed against the repository's source code and official documentation.


17. Responsible AI Development

EveryO is a neural computing framework, and its community should promote responsible experimentation.

17.1 Research Integrity

Contributors should report:

  • Experimental setup.
  • Data assumptions.
  • Evaluation methods.
  • Limitations.
  • Reproducibility constraints.

17.2 Dataset Responsibility

Use datasets in accordance with their licenses and applicable privacy requirements.

17.3 Accuracy Claims

Avoid claiming perfect accuracy or universal model performance without evidence.

17.4 Reproducibility

Provide:

  • Seeds.
  • Software versions.
  • Dataset details.
  • Hyperparameters.
  • Evaluation procedures.

17.5 Security

Do not introduce malicious behavior, credential harvesting, or unauthorized data transmission.

17.6 Transparency

Clearly distinguish experimental results from established functionality.


18. Security and Responsible Disclosure

Security issues require special handling.

18.1 Private Reporting

Use:

GitHub Private Vulnerability Reporting

18.2 Do Not Disclose Publicly

Do not post:

  • Exploit details.
  • Sensitive attack instructions.
  • Confidential vulnerability reports.
  • Private credentials.

18.3 Reporting Information

Provide:

  • Affected component.
  • Relevant version.
  • Reproduction steps.
  • Security impact.
  • Suggested mitigation, if available.

18.4 Security Policy

Refer to:

SECURITY.md


19. Privacy and Confidentiality

19.1 Protect Personal Information

Do not publish another person's private information without authorization.

19.2 Protect Credentials

Never commit:

  • Passwords.
  • API tokens.
  • Private keys.
  • Access credentials.

19.3 Protect Sensitive Data

Do not upload confidential datasets or internal company information to public issues.

19.4 Logs and Diagnostics

Remove sensitive information before sharing logs.

19.5 Third-Party Services

Contributors should understand the privacy implications of any new external integration.


20. Spam and Promotional Content

The repository rules prohibit spam and deceptive promotional activity.

20.1 Unacceptable Examples

  • Repeated duplicate issues.
  • Irrelevant advertising.
  • Automated promotional comments.
  • Artificial contribution activity.
  • Misleading project endorsements.

20.2 Relevant References

A link to another project may be useful when it directly supports a technical discussion.

20.3 Promotion Versus Contribution

A genuine technical contribution should provide demonstrable value to EveryO.

20.4 Community Trust

Do not manipulate stars, issues, pull requests, or review activity to create a misleading impression of popularity.


21. Community Moderation

Moderation helps maintain a safe and productive environment.

21.1 Moderation Objectives

  • Protect participants.
  • Enforce community standards.
  • Prevent disruption.
  • Maintain technical discussion quality.

21.2 Possible Actions

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.

21.3 Proportionality

Moderation decisions should consider severity, context, and repeated behavior.

21.4 Privacy

Sensitive reports should be handled with appropriate confidentiality.

21.5 Policy Authority

The official Code of Conduct defines the enforcement framework.


22. Reporting Community Concerns

22.1 Conduct Concerns

Use the reporting mechanism identified in the repository's Code of Conduct.

Read the Code of Conduct

22.2 Security Concerns

Use private vulnerability reporting.

22.3 Technical Problems

Use GitHub Issues.

22.4 General Questions

Use GitHub Discussions.

22.5 Reporting Guidelines

Include relevant context while avoiding unnecessary disclosure of private information.


23. Maintainer Responsibilities

Maintainers play a central role in community health.

23.1 Technical Responsibilities

  • Review contributions.
  • Maintain repository quality.
  • Manage releases.
  • Evaluate architectural changes.
  • Preserve project consistency.

23.2 Community Responsibilities

  • Apply policies consistently.
  • Encourage constructive discussion.
  • Respond to concerns appropriately.
  • Communicate technical decisions clearly.

23.3 Transparency

Where appropriate, maintainers should explain significant technical decisions.

23.4 Limitations

Maintainers are not required to accept every contribution or provide unlimited support.

23.5 Governance

Refer to:

GOVERNANCE.md


24. Community Events and Initiatives

The following are potential community initiatives rather than confirmed existing programs.

24.1 Proposed Activities

  • Beginner contribution sessions.
  • Documentation improvement drives.
  • Numerical correctness workshops.
  • Open-source mentoring.
  • Architecture discussions.
  • Testing and benchmarking events.

24.2 Event Principles

Community activities should be:

  • Inclusive.
  • Technically meaningful.
  • Voluntary.
  • Respectful.
  • Transparent.

24.3 Participation

Any proposed event should identify organizers, scope, dates, and participation requirements before being announced.


25. Recommended Community Workflow

25.1 Standard Collaboration

             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

25.2 Community Success

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.


26. Community FAQ

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.


27. Official Resources

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

28. Final Community Commitment

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.


Community Guidelines — Documentation Prepared

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

⚠️ **GitHub.com Fallback** ⚠️