Skip to content

Commit

Permalink
Enhance Clarity and Formatting in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Faisal-Alsrheed authored Jan 29, 2024
1 parent 0829fdc commit 573e93f
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
Keras 3 is a high-velocity open-source project. We welcome contributions!

Contributions can be made in a variety of ways, including coding, enriching documentation, refining docstrings, and offering examples of code.


## The Current Opportunities to Contribute
Check this [link](https://github.com/keras-team/keras/issues/18442) to find the current opportunities to contribute.


## How to contribute code

Follow these steps to submit your code contribution.
Expand All @@ -9,7 +18,7 @@ exist) and discussing your proposed changes. This way, we can give you feedback
and validate the proposed changes.

If the changes are minor (simple bug fix or documentation fix), then feel free
to open a PR without discussion.
to open a Pull Request (PR) without discussion.

### Step 2. Make code changes

Expand All @@ -31,6 +40,7 @@ the check will pass.

![CLA signed](https://github.com/keras-team/keras/assets/1091026/71c26353-e3b5-4135-8bae-64693c717775)


### Step 5. Code review

If the tests fail, look into the error messages and try to fix them.
Expand All @@ -56,7 +66,7 @@ for your reference.
## Setup environment

We provide two ways of setting up a development environment. One is to use a
dev container, and the other one is to setup a local environment by installing
dev container, and the other one is to set up a local environment by installing
the dev tools needed.

### Option 1: GitHub Codespace or dev container
Expand All @@ -65,9 +75,9 @@ We support GitHub Codespaces, Visual Studio Code dev containers and JetBrain dev
containers. Please see the
[Dev container documentation](https://github.com/keras-team/keras/tree/master/.devcontainer).

### Option 2: Setup a local environment
### Option 2: Set up a local environment

To setup your local dev environment, you will need the following tools.
To set up your local dev environment, you will need the following tools.

1. [git](https://github.com/) for code repository management.
2. [python](https://www.python.org/) to build and code in Keras.
Expand Down Expand Up @@ -99,7 +109,7 @@ section of the README.

## Code style

The Keras uses [Black](https://black.readthedocs.io/en/stable/) and
Keras uses [Black](https://black.readthedocs.io/en/stable/) and
[isort](https://pycqa.github.io/isort/) to format the code. Please refer to
[requirements-common.txt](https://github.com/keras-team/keras/blob/master/requirements-common.txt)
for the required versions. Run the following command **at the root directory of
Expand Down

0 comments on commit 573e93f

Please sign in to comment.