Merge pull request #5 from orkunkaraduman/develop

v0.3.2

CODE_OF_CONDUCT.md

@@ -0,0 +1,55 @@
+# oscdn - Code of Conduct
+
+As contributors and maintainers of oscdn, we pledge to create a friendly, respectful, and inclusive environment for everyone involved. We value the participation of all contributors, regardless of their background or experience level, and we are committed to providing a harassment-free experience for everyone.
+
+## Our Standards
+
+To achieve a positive and welcoming community, we expect all contributors to adhere to the following standards:
+
+### 1. Be Respectful
+
+Treat all individuals with respect and kindness. Respect differences in opinion, viewpoints, and experiences. Avoid offensive, derogatory, or discriminatory language and behavior.
+
+### 2. Be Inclusive
+
+Welcome all contributors regardless of their background or experience level. Encourage and support new contributors, and help them feel comfortable and valued within the community.
+
+### 3. Be Collaborative
+
+Work together in a collaborative and constructive manner. Value the contributions of others and be willing to collaborate on finding the best solutions to challenges.
+
+### 4. Be Professional
+
+Maintain a professional and courteous demeanor in all interactions. Refrain from any personal attacks, insults, or inappropriate conduct.
+
+### 5. Be Open-Minded
+
+Be open to feedback and different ideas. Be willing to consider alternative viewpoints and learn from others.
+
+## Unacceptable Behavior
+
+The following behaviors are considered unacceptable within the oscdn community:
+
+- Harassment, intimidation, or discrimination of any form.
+- Offensive, derogatory, or discriminatory language or imagery.
+- Personal attacks, insults, or disrespectful conduct.
+- Trolling, spamming, or any form of disruptive behavior.
+- Any behavior that violates applicable laws or regulations.
+
+## Reporting and Enforcement
+
+If you experience or witness any behavior that violates this Code of Conduct, please report it to me at [ok@orkunkaraduman.com](mailto:ok@orkunkaraduman.com). All reports will be kept confidential and will be reviewed and addressed promptly.
+
+Contributors who violate the Code of Conduct may be subject to temporary or permanent exclusion from the project community, as decided by the project maintainers.
+
+## Scope
+
+This Code of Conduct applies to all interactions within the oscdn project, including but not limited to GitHub repositories, issues, pull requests, social media platforms, and any community events or gatherings.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html) version 2.0.
+
+## Thank You
+
+Thank you for contributing to the oscdn project and helping to create a positive and inclusive community. Your adherence to this Code of Conduct helps to ensure that oscdn remains a welcoming and productive space for all participants.

CONTRIBUTING.md

@@ -1,3 +1,69 @@
-# Contributing
+# Contributing to oscdn
 
-under development
+Thank you for your interest in contributing to oscdn! We appreciate your help in making this project better. Before you start contributing, please take a moment to review the following guidelines to ensure a smooth and effective collaboration.
+
+## Code of Conduct
+
+Please review our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the expected behavior in our community. We expect all contributors to adhere to these guidelines when participating in the project.
+
+## How to Contribute
+
+Contributing to oscdn is a straightforward process. Here are the general steps to follow:
+
+- Fork the Repository: Start by forking the oscdn repository to your GitHub account.
+
+- Clone the Repository: Clone the forked repository to your local machine using the following command:
+
+```shell
+git clone https://github.com/orkunkaraduman/oscdn.git
+cd oscdn
+```
+
+- Create a Branch: Before making changes, create a new branch with a descriptive name for your feature or bug fix:
+
+```shell
+git checkout -b feature/my-new-feature
+```
+
+- Use the `feature/` prefix for adding new features and `bug/` prefix for bug fixes.
+
+- Make Changes: Implement your changes, following the coding conventions and best practices of the project.
+
+- Test Your Changes: Thoroughly test your changes to ensure that they work as expected and do not introduce any regressions.
+
+- Commit Your Changes: Once you're satisfied with your changes, commit them with a meaningful commit message:
+
+```shell
+git add .
+git commit -m "Add my new feature"
+```
+
+- Push Your Changes: Push the changes to your forked repository:
+
+```shell
+git push origin feature/my-new-feature
+```
+
+- Create a Pull Request: Go to the original oscdn repository on GitHub and create a Pull Request (PR) from your branch to develop branch. Make sure to provide a clear and detailed description of your changes in the PR.
+
+- Code Review: The project maintainers will review your PR. Please be patient during this process, and be prepared to address any feedback or requests for changes.
+
+- Merge and Release: If your PR is approved, it will be merged into the develop branch, and your changes will be included in the next release.
+
+## Reporting Issues
+
+If you encounter any bugs, have feature requests, or want to suggest improvements, please feel free to open an issue on GitHub. When reporting an issue, provide as much detail as possible to help us understand and reproduce the problem.
+
+## License
+
+By contributing to oscdn, you agree that your contributions will be licensed under the [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause).
+
+## Acknowledgments
+
+Thank you for contributing to oscdn! Your efforts and contributions are valuable in making oscdn a reliable and efficient CDN solution.
+
+## Contact
+
+If you have any questions or need further assistance, you can reach me at [ok@orkunkaraduman.com](mailto:ok@orkunkaraduman.com).
+
+Happy Contributing!

README.md

@@ -38,8 +38,8 @@ Follow the steps below to get oscdn up and running on your server:
 ## Contributing
 
 We welcome contributions from the community to improve and expand oscdn's capabilities. If you find a bug, have a
-feature request, or want to contribute code, please follow our guidelines for contributing (CONTRIBUTING.md) and submit
-a pull request.
+feature request, or want to contribute code, please follow our guidelines for contributing
+([CONTRIBUTING.md](CONTRIBUTING.md)) and submit a pull request.
 
 ## License
 
@@ -49,3 +49,7 @@ oscdn is open-source software released under the [BSD 3-Clause License](https://
 
 We would like to thank the open-source community and the developers of the libraries and tools that oscdn depends on.
 Your contributions help make oscdn a reliable and powerful CDN solution.
+
+## Contact
+
+If you have any questions, suggestions, or need support, you can reach me at [ok@orkunkaraduman.com](mailto:ok@orkunkaraduman.com).