From 201b33bc409c469b27fd40b73d583580d8e90c5f Mon Sep 17 00:00:00 2001 From: leftkats Date: Fri, 6 Jun 2025 16:30:10 +0300 Subject: [PATCH] doc: add contribution guidelines --- CONTRIBUTING.md | 31 +++++++++++++++++ CONTRIBUTIONS.md | 90 ------------------------------------------------ README.md | 4 ++- 3 files changed, 34 insertions(+), 91 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 CONTRIBUTIONS.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..68ebedab --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing to This Repository + +Thank you for your interest in contributing! We welcome contributions of Python scripts and improvements to this repository. + +## How to Contribute + +1. **Discuss First** + Before making any changes, please open an issue to discuss your idea with the maintainers. This helps us coordinate and avoid duplication. + +2. **Make Your Contribution** + - Fork the repository. + - Create a new folder named after your script or its purpose (short and descriptive). + - Add your Python script(s) inside this folder. + - Include a `README.md` in that folder explaining what your script does and any prerequisites. + - Update the main `README.md` by adding your script to the **List of Scripts** with its name, a brief description, and a link to your script folder. + +3. **Open a Pull Request (PR)** + - Link your PR to the issue you created earlier. + - We will review your changes and provide feedback or merge it if everything looks good. + +4. **Clean Up** + Ensure any temporary install or build dependencies are removed before submitting your PR. + +## First-Time Contributors + +If this is your first time contributing to an open source project, check out this helpful guide: +[How to Make Your First Contribution](https://opensource.guide/how-to-contribute/) + +## Code of Conduct + +We strive to maintain a welcoming and inclusive community. Please read and respect our [Code of Conduct](https://github.com/DhanushNehru/Python-Scripts/blob/master/CODE_OF_CONDUCT.md) in all your interactions. diff --git a/CONTRIBUTIONS.md b/CONTRIBUTIONS.md deleted file mode 100644 index 6cbcddf1..00000000 --- a/CONTRIBUTIONS.md +++ /dev/null @@ -1,90 +0,0 @@ -# Contributing - -When contributing to this repository, please first discuss the change you wish to make via issue, with the maintainers of this repository before making a change. - -First time contributers can refer to various resources on how -to make their first contribution, one which we would refer is [this.][first] - -Please note we have a code of conduct, please follow it in all your interactions with the project. - -## Pull Request Process - -1. Create an issue and fork the repository, add a new folder with a name that describes your script in short. You'll place your Python script(s) in there. -2. Add a `README.md` in that file which explains your script -and any prerequisites it may have. -3. Update the main `README.md`, adding your script to the List of Scripts in Repo, providing the script's name, a link to it, and a brief description. -4. Mention the issue you made in 1) in your Pull Request, which will be then verified and merged accordingly. -5. Ensure any install or build dependencies are removed before the end of the layer when doing a build. - ---- -## Code of Conduct - -### Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. - -### Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or -advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -### Our Responsibilities - -Project maintainers 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. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -### Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -### Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at [INSERT EMAIL ADDRESS]. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -### Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available [here.][version] diff --git a/README.md b/README.md index 11c8c40e..ff757cb7 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,9 @@ _**Note: Please follow the maintainer of the repository for quick approval of th **NOTE:** Remember to close your issues once your PR has been merged! They can be reopened if needed. -More information on contributing and the general code of conduct for discussion and feedback in this repo can be found here: [CONTRIBUTIONS.md](https://github.com/DhanushNehru/Python-Scripts/blob/master/CONTRIBUTIONS.md) +More information on contributing can be found here: [CONTRIBUTING.md](https://github.com/DhanushNehru/Python-Scripts/blob/master/CONTRIBUTING.md) + +General code of conduct for discussion and feedback in this repo can be found here: [CODE_OF_CONDUCT.md](https://github.com/DhanushNehru/Python-Scripts/blob/master/CODE_OF_CONDUCT.md) ## List of Scripts in Repo