From 32c24848a3d3fd9306008c56e744c1a565ddf163 Mon Sep 17 00:00:00 2001 From: onihilist Date: Thu, 24 Apr 2025 16:35:29 +0200 Subject: [PATCH 1/2] add COC & CONTRIB markdown files --- CODE_OF_CONDUCT.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..1524552 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Code of Conduct for NShell + +We are committed to making participation in the NShell project a harassment-free experience for everyone. We ask that you follow this code of conduct to ensure a respectful and welcoming environment for all participants. + +## Our Pledge + +In the spirit of community, collaboration, and respect, we pledge to: + +- Be kind and considerate in our interactions. +- Listen to others and value their contributions. +- Acknowledge and address concerns raised by community members. +- Provide helpful feedback and constructive criticism. + +## Our Standards + +Examples of behavior that contribute to a positive environment include: + +- Using inclusive and respectful language. +- Being open to differing opinions, viewpoints, and experiences. +- Sharing knowledge and experiences for the benefit of others. +- Asking for clarification and offering help when needed. + +Examples of unacceptable behavior include: + +- Discriminatory, offensive, or harassing language or actions. +- Trolling, insulting, or personally attacking others. +- Disrupting discussions or project activities. +- Repeatedly bringing up topics that have been resolved or disregarding community decisions. + +## Enforcement + +If you experience or witness unacceptable behavior, or have any concerns, please report it to the project maintainers immediately. + +Project maintainers are responsible for enforcing the Code of Conduct. They have the authority to remove issues, pull requests, or participants that do not adhere to this code. + +## Scope + +This Code of Conduct applies within all project spaces, including but not limited to: + +- The GitHub repository. +- Communication channels (e.g., discussions, issues, PRs, etc.). +- Any other platform where project-related discussions happen. + +--- + +Thank you for helping us keep NihilistShell a welcoming space for everyone. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..105aeee --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing to NShell + +Thank you for considering contributing to NShell! We appreciate your efforts in improving the project. By participating, you agree to follow the guidelines laid out below. + +## How to Contribute + +### Reporting Issues +If you encounter a bug or have a question, please report it using the "Issues" tab of the GitHub repository. Provide as much detail as possible about the issue, including: + +- A description of the problem. +- Steps to reproduce the issue. +- Expected and actual results. +- Any relevant logs or error messages. + +### Submitting Code +We welcome code contributions! To ensure the process is smooth, please follow these steps: + +1. **Fork the repository** and clone it to your local machine. +2. **Create a new branch** for your changes. It's best to name it according to the feature or bug you're working on, e.g., `feature/new-feature` or `fix/fix-issue`. +3. **Make your changes** and test them thoroughly. +4. **Commit your changes** with a clear and concise commit message. Use the present tense (e.g., "fix: fix message", "feat: feature message"). +5. **Push your changes** to your forked repository. +6. **Create a pull request** to the main repository, providing a description of the changes and why they are necessary. + +### Code Style +Please adhere to the following guidelines when writing code: + +- Use consistent indentation (spaces, not tabs). +- Write clear, concise, and self-explanatory variable names. +- Include comments where necessary to explain complex logic. +- Follow best practices for writing secure and efficient code. + +## Code Reviews +All pull requests will undergo code review by the maintainers. They may request changes or provide feedback. Please respond promptly to ensure the PR can be merged. + +Thank you for your contributions! + +--- + +Happy coding, and thank you for contributing to NihilistShell! From f22483a54050ec133bdd6252b04e8daa4aae9a08 Mon Sep 17 00:00:00 2001 From: onihilist Date: Thu, 24 Apr 2025 16:41:01 +0200 Subject: [PATCH 2/2] add COC & CONTRIB markdown files --- CODE_OF_CONDUCT.md | 5 +++-- CONTRIBUTING.md | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 1524552..d1b21c3 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,6 +1,7 @@ # Code of Conduct for NShell -We are committed to making participation in the NShell project a harassment-free experience for everyone. We ask that you follow this code of conduct to ensure a respectful and welcoming environment for all participants. +We are committed to making participation in the NShell project a harassment-free experience for everyone. +We ask that you follow this code of conduct to ensure a respectful and welcoming environment for all participants. ## Our Pledge @@ -43,4 +44,4 @@ This Code of Conduct applies within all project spaces, including but not limite --- -Thank you for helping us keep NihilistShell a welcoming space for everyone. +Thank you for helping us keep NShell a welcoming space for everyone. (b ᵔ▽ᵔ)b diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 105aeee..d5cddfc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,8 +33,8 @@ Please adhere to the following guidelines when writing code: ## Code Reviews All pull requests will undergo code review by the maintainers. They may request changes or provide feedback. Please respond promptly to ensure the PR can be merged. -Thank you for your contributions! +Thank you for your contributions ! <3 --- -Happy coding, and thank you for contributing to NihilistShell! +Happy coding, and thank you for contributing to NShell ! ヽ(・∀・)ﾉ