Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Contributor Covenant 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, 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 behavior that contributes to a positive environment 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

## 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 within all project spaces, and also applies when
an individual is officially representing the project in public spaces.

Examples of representing our project 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

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer.

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 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq.
Translations are available at
https://www.contributor-covenant.org/translations.
67 changes: 67 additions & 0 deletions CONRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Contributing to **noobcodes-docs**

## Thank you for considering contributing to noobcodes-docs!

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](CODE_OF_CONDUCT.md) before contributing to the project.

## Getting Started

1. Fork the repository:

* Create a personal copy of the `noobcodes-docs` repository on Github.
* You can do this by clicking the "Fork" button on the `noobcodes-docs` repository page.

2. 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.
* `git clone https://github.com/<YOUR-USERNAME>/noobcodes-docs.git`

3. 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 <branch-name>`


4. Make changes:

* Start making changes to the code, fixing bugs, adding new features, etc.

5. 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 <branch-name>`

## Submitting a Pull Request

1. Make sure your changes are well-documented and include relevant tests.

2. If you've added new functionality, include appropriate documentation.

3. Follow the coding conventions used in the project.

4. 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.

5. When you're ready, submit a pull request and include a descriptive title and a detailed description of your changes.

## Additional Resources

- [Project documentation](https://github.com/shelcia/noobcodes-docs)
- [Issue tracker](https://github.com/shelcia/noobcodes-docs/issues)

#

Thank you again for your interest in contributing to **noobcodes-docs**.

We look forward to working with you!