Skip to content

Commit

Permalink
Add contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
teociaps committed Jan 21, 2024
1 parent 53aa255 commit de8eee4
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Contributing to SwaggerUI.Themes

Thank you for considering contributing to **SwaggerUI.Themes**! We welcome contributions from the community to help improve and grow the project.

## Code of Conduct

This project and everyone participating in it are governed by our [Code of Conduct](CODE_OF_CONDUCT.md).

## How to Contribute

1. **Fork the repository to your GitHub account.**
2. Clone the forked repository to your local machine.
3. Create a **new branch** for your contribution:

```bash
git checkout -b feature/my-feature
```

4. Make your changes and commit them:

```bash
git commit -m "Add new feature"
```

5. Push the changes to your fork:

```bash
git push origin feature/my-feature
```

6. Open a **pull request (PR)** against the main branch of the original repository.

## Pull Request Guidelines
- Ensure your code adheres to the existing coding standards.
- Include relevant documentation and test cases for your changes.
- Keep your pull request focused. If you are addressing multiple issues, submit separate pull requests for each.
- Be responsive to comments and feedback on your pull request.

## Reporting Bugs and Issues
If you find a bug or have a question, please open an issue on GitHub. When reporting a bug, provide as much detail as possible, including:

- A clear and concise description of the bug.
- Steps to reproduce the issue.
- Expected behavior and actual behavior.
- Screenshots or code snippets, if applicable.

## Feature Requests
We welcome suggestions for new features or improvements. Please open an issue to propose your ideas.

Development Setup
To set up the project for local development, follow the instructions in the [README](README.md) file.

## License
By contributing to this project, you agree that your contributions will be licensed under the [License](LICENSE) file.

Thank you for your contributions!

**_@teociaps_**

0 comments on commit de8eee4

Please sign in to comment.