contributing guide⁂

thank you for your interest in contributing to the openai summarize diff action! this document provides guidelines and instructions for contributing to this project.

code of conduct⁂

we expect all contributors to follow our code of conduct. please be respectful and considerate of others when contributing to this project.

how to contribute⁂

there are many ways to contribute to this project:

1. report bugs: if you find a bug, please create an issue with details on how to reproduce it.

2. suggest features: if you have an idea for a new feature, create an issue with your suggestion.

3. submit pull requests: if you'd like to fix a bug or implement a feature, submit a pull request with your changes.

development setup⁂

to set up your development environment:

1. fork the repository on github.

2. clone your fork locally: bash git clone https://github.com/yourusername/openai-summarize-diff-action.git cd openai-summarize-diff-action

3. install dependencies: bash npm install

4. create a branch for your changes: bash git checkout -b my-feature-branch

5. make your changes and commit them with a clear commit message.

6. push your branch to your fork: bash git push origin my-feature-branch

7. create a pull request from your fork to the main repository.

coding standards⁂

• follow the existing code style and formatting conventions.
• write clear, concise comments and commit messages.
• add tests for new features or bug fixes.
• ensure all tests pass before submitting a pull request.
• update documentation as needed.

release process⁂

the release process is managed by the project maintainers. the general workflow is:

1. changes are merged into the main branch.
2. maintainers decide when to create a new release based on the changes.
3. a new version is tagged according to semantic versioning.
4. a github release is created with release notes.

license⁂

by contributing to this project, you agree that your contributions will be licensed under the project's license.

questions and acknowledgements⁂

if you have any questions about contributing, please open an issue or contact the project maintainers.

thank you for contributing to the openai summarize diff action!