diff --git a/code_of_conduct.md b/code_of_conduct.md new file mode 100644 index 0000000..9536f7d --- /dev/null +++ b/code_of_conduct.md @@ -0,0 +1,17 @@ +Code Of Conduct-STABO + +Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +Our Standards Examples of behaviour 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 behaviour include: + +The use of sexualized language or imagery, and sexual attention or advances 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 Our Responsibilities Project maintainers are responsible for clarifying and enforcing our standards of acceptable behaviour and will take appropriate and fair corrective action in response to any instances of unacceptable behaviour. + +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 behaviours that they deem inappropriate, threatening, offensive, or harmful. + +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 e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +Enforcement: contact: click here Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to the community leaders responsible for enforcement at <>. All complaints will be reviewed and investigated promptly and fairly. + +Attribution This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4 \ No newline at end of file diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..ddc4996 --- /dev/null +++ b/contributing.md @@ -0,0 +1,45 @@ +Contributing to STABO!!! +Thank you for considering contributing to mocker! Whether it's fixing a bug, proposing a new feature, or improving documentation, your contributions are greatly appreciated. + +Code of Conduct +Please make sure to read and follow our Code of Conduct before contributing to the project. + +Getting Started +Fork the Repository: +Create a personal copy of the stabo repository on Github. You can do this by clicking the "Fork" button on the stabo repository page. + +Clone the Repository Locally: +After forking the repository, clone it locally on your computer so that you can work on the code and make changes. Open a terminal and run the following git command: + +git clone "https://github.com//stabo.git" +Replace with your Github username. + +Create a New Branch: +Before making any changes, create a new branch in your local repository. This is done to ensure that your changes are isolated from the main branch and can be easily reviewed and merged later. + +git checkout -b +Make Changes: +Start making changes to the code, fixing bugs, adding new features, etc. + +Push Changes to the Fork: +Once the changes have been made, push them to your fork on Github. + +git add . +git commit -m "Description of changes" +git push origin +Submitting a Pull Request +Make sure your changes are well-documented and include relevant tests. If you've added new functionality, include appropriate documentation. + +Follow the coding conventions used in the project. + +Before submitting your pull request, make sure the following items have been checked: All tests pass, and the build is successful. + +Your changes do not produce any new warnings or errors. +Your changes have been thoroughly tested on different platforms and browsers. +Your changes do not break backward compatibility. +When you're ready, submit a pull request and include a descriptive title and a detailed description of your changes. + +Additional Resources +Project Documentation +Issue Tracker +Thank you again for your interest in contributing to stabo. We look forward to working with you! \ No newline at end of file