-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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 | ||
|
||
## 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! | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
There was a problem hiding this comment.
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.
Copilot uses AI. Check for mistakes.