Skip to content

Commit

Permalink
Add open source standar files
Browse files Browse the repository at this point in the history
  • Loading branch information
Aditya-Jyoti committed Apr 9, 2024
1 parent 35a8e13 commit e3e2c64
Show file tree
Hide file tree
Showing 3 changed files with 163 additions and 1 deletion.
73 changes: 73 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# 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, 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 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 {{ email }}. 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 at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
74 changes: 74 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributing Guidelines

Thank you for considering contributing to our web project! We welcome contributions from everyone, regardless of their level of expertise. To ensure a smooth collaboration process, please take a moment to review the following guidelines.

## How to Contribute

1. **Fork the repository:**

Visit [the repository](https://github.com/Aditya-Jyoti/Introduce-Yourself)
and click on the "Fork" button in the top-right corner of the page.
This will create a copy of the repository in your GitHub account.

2. **Clone the repository:**

After forking, clone the repository to your local machine using the following command

```bash
git clone <url>
```

_replace url with the url to your repo_

3. **Create a new folder:**

Inside `src/content/introductions`, create a new folder with your name. eg: `Aditya Jyoti`

4. **Add an introduction file:**

Inside the folder you just created, add a file named `introduction.md`.

5. **Write your introduction:**

In the `introduction.md` file, provide information about yourself.

```markdown
---
name: [your name]
interests: [3 comma separated interests]
description: [talk about yourself]
github: [add your github link]
image: [true or false]
---
```

6. **Stage your changes:**

Use the following command to stage your changes:

```bash
git add .
```
7. **Commit your changes:**

Commit your changes with a descriptive message using the following command:

```bash
git commit -m "Add introduction for [Your Name]"
```

8. **Push your changes:**

Push your changes to your forked repository using the following command:

```bash
git push
```

9. **Create a Pull Request (PR):**

Visit the [main repository](https://github.com/aditya-jyoti/Introduce-Yourself) and click on the "New pull request" button. Compare the changes and submit your PR.

10. **Wait**


17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
# Introduce-Yourself
A basic start to open source contribution. Make a pr introducing yourself

Head on over to the [website](https://aditya-jyoti.github.io/Introduce-Yourself/) for more information and find your profile up there.

## About

Here you can make a PR introducing yourself my adding your introduction to `src/content/introductions/<your-name>/` so that you can get your first open source contribution down. Meet other people with similar passions as you make connections for the future and help each other out in your development journey.

## Don't know how git/github works?

Don't worry if you don't know what the above words mean. If you want to learn head on over to [documentation](https://github.com/Aditya-Jyoti/All-About-Git-And-Github) that I have written and it should take you through everything you might need to get started.

## How to start contribution

Read the [CONTRIBUTING.md](https://github.com/Aditya-Jyoti/Introduce-Yourself/blob/main/CONTRIBUTING.md) file so as to get to know how to get started with contributing here.

Read the [CODE_OF_CONDUCT.md](https://github.com/Aditya-Jyoti/Introduce-Yourself/blob/main/CODE_OF_CONDUCT.md) and follow that.

0 comments on commit e3e2c64

Please sign in to comment.