Skip to content

Commit

Permalink
add missing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Hasnain Mohi Ud Din authored and Hasnain Mohi Ud Din committed Dec 18, 2024
1 parent 5bf8e57 commit 0ce9d65
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: MoviePy
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names:
family-names:
repository-code: 'https://github.com/swagger-api/swagger-ui'
abstract: >-
Swagger UI allows anyone to visualize and interact with the
API’s resources without having any of the implementation
logic in place
license: Apache 2.0 License
version: 5.18.2
date-released: '2024-11-07'
31 changes: 31 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributor Covenant Code of Conduct

## Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

## Our Standards
Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people.
- Being respectful of differing opinions, viewpoints, and experiences.
- Giving and gracefully accepting constructive feedback.
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience.
- Focusing on what is best not just for us as individuals, but for the overall community.

Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind.
- Trolling, insulting or derogatory comments, and personal or political attacks.
- Public or private harassment.
- Publishing others’ private information, such as a physical or email address, without their explicit permission.
- Other conduct which could reasonably be considered inappropriate in a professional setting.

## Enforcement Responsibilities
Community leaders are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

## Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Attribution
This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to the Project

Thank you for considering contributing to our project! We welcome contributions from everyone, whether you're a newcomer or a seasoned developer. Please follow the guidelines below to ensure a smooth collaboration.

## General Project Workflow

1. **Fork the Repository**: Start by forking the repository to your own GitHub account.
2. **Create a Branch**: Create a new branch for your feature or bug fix.
3. **Make Changes**: Implement your changes in the new branch.
4. **Submit a Pull Request**: Once your changes are ready, submit a pull request for review.

## Getting Items on the Agenda

To propose new features or changes, please open an issue in the repository. Clearly describe your suggestion and its benefits. The team will review it and decide whether to add it to the agenda.

## Decision-Making Process

Decisions are made collaboratively by the core team, considering input from all contributors. Major changes will be discussed in issues or pull requests to gather feedback.

## Contribution Guidelines

### Technical Guidelines

- **Naming Conventions**: Use camelCase for function names (e.g., `myFunctionName`).
- **Issue Tags**: Tag issues with appropriate labels such as `bug`, `feature`, or `enhancement` to categorize them effectively.
- **Installation and Configuration**: Follow the installation instructions in the README to set up the development environment. Ensure you have the necessary dependencies installed.

## Additional Notes

- Please ensure your code adheres to the project's coding standards.
- Before submitting a pull request, make sure to run tests to verify that your changes do not break existing functionality.

## Acknowledgments

We appreciate all contributions and look forward to collaborating with you!

---

By convention, please also add a section in the README file that links to this CONTRIBUTING.md for easy access.

0 comments on commit 0ce9d65

Please sign in to comment.