Skip to content

docs: add contributing guidelines #37

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 21, 2025
Merged

docs: add contributing guidelines #37

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b67f4fa
docs: add contributing guidelines
michaelbe812 Jul 17, 2025
e841ea7
docs: add contributing guidelines
michaelbe812 Jul 17, 2025
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
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing to nx-plugin-openapi

Thank you for your interest in contributing! We welcome any contributions from everyone.

## Getting Started

1. Fork the repository
2. Clone your fork: `git clone https://github.com/your-username/nx-plugin-openapi.git`
3. Install dependencies: `npm install`
4. Create a branch: `git checkout -b your-branch-name`

## Development

- Follow the existing code style and conventions
- Write clear, descriptive commit messages
- Test your changes before submitting
- Keep functions small and focused
Comment on lines +14 to +17
Copy link
Preview

Copilot AI Jul 17, 2025

Choose a reason for hiding this comment

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

[nitpick] List formatting is inconsistent between sections (ordered lists under 'Getting Started' and bullet lists under 'Development'); consider using a consistent list style within each section for readability.

Suggested change
- Follow the existing code style and conventions
- Write clear, descriptive commit messages
- Test your changes before submitting
- Keep functions small and focused
1. Follow the existing code style and conventions
2. Write clear, descriptive commit messages
3. Test your changes before submitting
4. Keep functions small and focused

Copilot uses AI. Check for mistakes.


## Submitting Changes

1. Push your branch to your fork
2. Create a pull request with a clear description

## General

- Always use rebase instead of merge

## Questions?

Feel free to open an issue if you have questions or need help getting started. We're here to help!
Copy link
Contributor

Choose a reason for hiding this comment

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

The file is missing a newline at the end, which is a common formatting convention. Adding a newline character after the exclamation mark would align with standard file formatting practices that many tools and developers expect.

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

Loading