Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation/contribution section #221

Merged
merged 10 commits into from
Jul 10, 2023
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ If you wish to contribute code, and you have not signed our Contributor Licence
to do so when you open a Pull Request. For any questions about the CLA process, please refer to our
[FAQ](https://cla.vmware.com/faq).

For additional information about contributing, go to the [contribution documentation](contributrion/README.md)
For additional information about contributing, go to the [contribution section](contribution/README.md)
MarkArbogast marked this conversation as resolved.
Show resolved Hide resolved

## License

Expand Down
27 changes: 16 additions & 11 deletions contributing/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
# Contributing

Before you start contributing to the project, you should familiarize yourself with the [documentation](vmware.github.io/vmware-aria-operations-integration-sdk/),
[issue tracker](https://github.com/vmware/vmware-aria-operations-integration-sdk/issues), [project structure](index.md),
and basic functioning of every component.
Contributing to the project does not necessarily require familiarity with every component. To find a quick breakdown
of the smaller parts of this project, consult the [index](index.md), which breaks down the SDK Structure into small
components and references to help contributors find the necessary references without having to go in-depth into the
project's overall structure. For a more in-depth breakdown of the project structure, it would be beneficial for you
to have a look at the [documentation](vmware.github.io/vmware-aria-operations-integration-sdk/),
[issue tracker](https://github.com/vmware/vmware-aria-operations-integration-sdk/issues),
[project structure](index.md), and basic functioning of every component.
quirogas marked this conversation as resolved.
Show resolved Hide resolved
MarkArbogast marked this conversation as resolved.
Show resolved Hide resolved

## Environment
This project uses Python 3.9 - 3.12. All other dependencies can be installed via [poetry](https://python-poetry.org/), by
running:
This project uses Python 3.9 - 3.12. All other dependencies can be installed via [poetry](https://python-poetry.org/),
by running:

```shell
poetry install --only=dev
```

### Tests
Every change you make should be accompanied by appropriate tests. TO learn more about running current tests,
go to [Unit Tests](tests.md) documentation.
Every change you make should be accompanied by appropriate tests. To learn more about running current tests, visit
[Unit Tests](tests.md) documentation.

## Submit Your Contribution
Once you're confident in the changes, it's time to submit them. Create a pull request. Include a clear description of
the changes in the pull request along with any issues resolved, if any. The changes will then be reviewed by the maintainers
of the project. If there are any issues with your changes, one of the maintainers will give you feedback. You may need to make further changes based on
this feedback before your contribution is accepted.

Once you're confident in the changes, it's time to submit them. Create a pull request. Include a clear description
of the changes in the pull request, along with any issues resolved. The maintainers of the project will then review
the changes. If there are any issues with your changes, one of the maintainers will give you feedback. You may need
to make further changes based on the feedback before your contribution is accepted.