Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 2 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,37 +349,9 @@ Use `--yes` to skip the confirmation prompt.

## Contributing

Contributions are welcome. Please read our contributing guidelines before submitting pull requests.
Contributions are welcome. Please read our [contributing guidelines](docs/contributing.md) before submitting pull requests.

### Development Setup

1. Install the package with dev dependencies:

```bash
pip install -e ".[dev]"
```

2. Install pre-commit hooks:

```bash
pre-commit install
```

This enables automatic linting and formatting checks (via [Ruff](https://docs.astral.sh/ruff/)) on every commit.

To run the checks manually against all files:

```bash
pre-commit run --all-files
```

### Submitting Changes

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
All contributions must follow our [Code of Conduct](docs/code-of-conduct.md).

## License

Expand Down
95 changes: 95 additions & 0 deletions docs/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# 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, 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
* Disrespecting the community's time by sending spam or other unsolicited
commercial messages
* 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.

This Code of Conduct also applies outside the project spaces when the Project
Steward has a reasonable belief that an individual's behavior may have a
negative impact on the project or its community.

## Conflict Resolution

We do not believe that all conflict is bad; healthy debate and disagreement
often yield positive results. However, it is never okay to be disrespectful or
to engage in behavior that violates the project’s code of conduct.

If you see someone violating the code of conduct, you are encouraged to address
the behavior directly with those involved. Many issues can be resolved quickly
and easily, and this gives people more control over the outcome of their
dispute. If you are unable to resolve the matter for any reason, or if the
behavior is threatening or harassing, report it. We are dedicated to providing
an environment where participants feel welcome and safe.

Reports should be directed to keras-team@google.com, the
Project Steward(s) for Keras Remote. It is the Project Steward’s duty to
receive and address reported violations of the code of conduct. They will then
work with a committee consisting of representatives from the Open Source
Programs Office and the Google Open Source Strategy team. If for any reason you
are uncomfortable reaching out to the Project Steward, please email
opensource@google.com.

We will investigate every complaint, but you may not receive a direct response.
We will use our discretion in determining when and how to follow up on reported
incidents, which may range from not taking action to permanent expulsion from
the project and project-sponsored spaces. We will notify the accused of the
report and provide them an opportunity to discuss it before any action is taken.
The identity of the reporter will be omitted from the details of the report
supplied to the accused. In potentially harmful situations, such as ongoing
harassment or threats to anyone's safety, we may take action without notice.

## Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct/
Comment on lines +93 to +95
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This Code of Conduct is based on version 1.4 of the Contributor Covenant from 2016. While this is acceptable, you might consider updating to a more recent version like 2.1 (from 2021). The newer versions include some clarifications and are more commonly adopted in new projects. This would require updating the body of this document to match the text of the newer version, which can be found at https://www.contributor-covenant.org/version/2/1/code_of_conduct/.

68 changes: 68 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# How to contribute

We'd love to accept your patches and contributions to this project.

## Before you begin

### Sign our Contributor License Agreement

Contributions to this project must be accompanied by a
[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
You (or your employer) retain the copyright to your contribution; this simply
gives us permission to use and redistribute your contributions as part of the
project.

If you or your current employer have already signed the Google CLA (even if it
was for a different project), you probably don't need to do it again.

Visit <https://cla.developers.google.com/> to see your current agreements or to
sign a new one.

### Review our community guidelines

This project follows
[Google's Open Source Community Guidelines](https://opensource.google/conduct/).

## Contribution process

### Development setup

1. Install the package with development dependencies:

```bash
pip install -e ".[dev]"
```

2. Install pre-commit hooks:

```bash
pre-commit install
```

### Code quality and testing

Before submitting a pull request, please ensure your changes pass linting and unit tests.

- **Linting:** We use [Ruff](https://docs.astral.sh/ruff/) for linting and formatting. Run it with:
```bash
ruff check .
```
- **Testing:** We use [Pytest](https://docs.pytest.org/) for unit tests. Run them with:
```bash
pytest
```
Comment on lines +42 to +53
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The instructions for code quality and testing could be clearer about the role of pre-commit. The previous instructions in README.md explained that pre-commit automates linting, but that context is lost here. This suggestion clarifies that pre-commit runs checks automatically on commit and provides the idiomatic command to run them manually, which is clearer for contributors.

Suggested change
### Code quality and testing
Before submitting a pull request, please ensure your changes pass linting and unit tests.
- **Linting:** We use [Ruff](https://docs.astral.sh/ruff/) for linting and formatting. Run it with:
```bash
ruff check .
```
- **Testing:** We use [Pytest](https://docs.pytest.org/) for unit tests. Run them with:
```bash
pytest
```
### Code quality and testing
After installing pre-commit hooks, linting and formatting checks will run automatically on every commit. Before submitting a pull request, please ensure all checks and unit tests pass.
You can also run the checks manually:
- **Linting & Formatting:** To run checks on all files, use:
```bash
pre-commit run --all-files
  • Testing: We use Pytest for unit tests. Run them with:
    pytest

<details>
<summary>References</summary>

1. The repository style guide emphasizes minimizing cognitive load for users and providing good documentation (lines 50, 103). The suggested change improves the clarity of the contribution workflow, reducing potential confusion for new contributors. <sup>([link](https://github.com/keras-team/remote/blob/main/.gemini/styleguide.md))</sup>
</details>


### Submitting changes

1. Fork the repository
2. Create a feature branch: `git checkout -b feature/amazing-feature`
3. Commit your changes: `git commit -m 'Add amazing feature'`
4. Push to the branch: `git push origin feature/amazing-feature`
5. Open a Pull Request

### Code reviews

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.