Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme and Contribution Guidelines #28

Merged
merged 19 commits into from
May 26, 2020
100 changes: 100 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# Contributing

[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/mobile-web-dev/mobile-web.dev)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat&logo=git&logoColor=white)](https://github.com/mobile-web-dev/mobile-web.dev) [![GitHub issues](https://img.shields.io/github/issues/mobile-web-dev/mobile-web.dev?logo=github)](https://github.com/codeuino/mobile-web-dev/issues) ![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/mobile-web-dev/mobile-web.dev?logo=git&logoColor=white) ![GitHub contributors](https://img.shields.io/github/contributors/mobile-web-dev/mobile-web.dev?logo=github) [![GitHub last commit](https://img.shields.io/github/last-commit/mobile-web-dev/mobile-web.dev?logo=github)](https://github.com/mobile-web-dev)

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, do follow it in all your interactions with the project.

## Pull Requests

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
3. We strictly use Git Flow and try to have a linear merge. Please follow the guidelines below.

## Git Flow

**1.** Fork [this](https://github.com/mobile-web-dev/mobile-web.dev) repository.

**2.** Clone the forked repository.

```terminal
git clone https://github.com/<your-github-username>/mobile-web.dev.git
```

**3.** Navigate to the project directory.

```terminal
cd mobile-web-dev/
```

**4.** Create a new branch.

```terminal
git checkout -b <your_branch_name>
```

**5.** Make changes in source code.

**6.** Commit your changes.

```terminal
git add .
git commit -m "<your_commit_message>"
```

**7.** Push your local branch to the remote repository.

```terminal
git push -u origin <your_branch_name>
```

**8.** Create a PR!

**9.** **Congratulations!** Sit and relax, you've made your contribution to the [Mobile-web.dev](https://github.com/mobile-web-dev/mobile-web.dev) project.


## 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 behaviour 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 behaviour 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 behaviour and are expected to 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 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 behaviour may be reported by contacting the project team at [email protected]. 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](http://contributor-covenant.org), [version 1.4](http://contributor-covenant.org/version/1/4/).
49 changes: 47 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,47 @@
# mobile-web.dev
Landing page website
# Mobile-web.dev

[![first-timers-only](https://img.shields.io/badge/first--timers--only-friendly-tomato.svg?style=flat&logo=git)](https://github.com/mobile-web-dev/mobile-web.dev/issues) [![GitHub stars](https://img.shields.io/github/stars/mobile-web-dev/mobile-web.dev.svg?logo=github)](https://github.com/mobile-web-dev/mobile-web.dev/stargazers) [![GitHub forks](https://img.shields.io/github/forks/mobile-web-dev/mobile-web.dev.svg?logo=github&color=teal)](https://github.com/mobile-web-dev/mobile-web.dev/network) [![GitHub top language](https://img.shields.io/github/languages/top/mobile-web-dev/mobile-web.dev?color=yellow&logo=javascript)](https://github.com/mobile-web-dev/mobile-web.dev)

![](assets/mobile-web.png)

## Initiatives

[Wordpress Crash Course](https://www.youtube.com/playlist?list=PL6IEQd6VwYfh4X_QWdmpd6xMRH9jnILyT)

[Web Hosting and Cloud Crash Course](https://www.youtube.com/playlist?list=PL6IEQd6VwYfiel0OdURL3vdq8hDA1oocC)




## Contribution Guidelines

[![GitHub issues](https://img.shields.io/github/issues/mobile-web-dev/mobile-web.dev?logo=github)](https://github.com/codeuino/mobile-web-dev/issues) ![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/mobile-web-dev/mobile-web.dev?logo=git&logoColor=white) ![GitHub contributors](https://img.shields.io/github/contributors/mobile-web-dev/mobile-web.dev?logo=github) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat&logo=git&logoColor=white)](https://github.com/mobile-web-dev) [![GitHub last commit](https://img.shields.io/github/last-commit/mobile-web-dev/mobile-web.dev?logo=github)](https://github.com/mobile-web-dev)


- Please read our [Code of Conduct](https://github.com/AnjaliSharma1234/mobile-web.dev/blob/master/CODE_OF_CONDUCT.md) and [Contributing guidelines](https://github.com/AnjaliSharma1234/mobile-web.dev/blob/master/CONTRIBUTING.md) for contributing towards the project.
- Write clear meaningful git commit messages (Do read [this](http://chris.beams.io/posts/git-commit/)).
- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check [this](https://github.com/blog/1506-closing-issues-via-pull-requests) for more info)
- When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterwards so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at [here](https://davidwalsh.name/squash-commits-git))
- When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
- Always create PR to `develop` branch.

## The Team

[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/mobile-web-dev/mobile-web.dev) ![GitHub pull requests](https://img.shields.io/github/issues-pr-closed-raw/mobile-web-dev/mobile-web.dev?logo=git&logoColor=white)

| Name | GitHub Usernames |
| ---------------------------------------------------- | -------------------------- |
| Aman Sharma | [@amanintech](https://github.com/amanintech) |
| Siddhant Kumar | [@siddhantdante](https://github.com/siddhantdante)|
| Monika Rajput | [@monika0123](https://github.com/monika0123)|
| Shalini Bose | [@shalinibose](https://github.com/shalinibose)|
| Anjali Sharma | [@AnjaliSharma1234](https://github.com/AnjaliSharma1234)|
| Harsh Akshit | [@harshakshit](https://github.com/harshakshit)|

## Contact us
![](assets/mobile-web_2.png)

|[Github](https://github.com/mobile-web-dev)| [Youtube](https://www.youtube.com/channel/UCSQKDMqwOp43dEqDt2hBOIQ/featured) | [Instagram](https://www.instagram.com/mobile_web.dev/) | [Twitter](https://twitter.com/mobile_web_hq) | [Linkedin](https://www.linkedin.com/company/mobile-web-dev/) | [Facebook](https://www.facebook.com/MobWeb.dev/) | [Slack](https://mobile-web.dev/slack/) | [Meetup](https://www.meetup.com/mobile-web-dev/) |
| - | - | - | - | - | - | - | - |

[![built with love](https://forthebadge.com/images/badges/built-with-love.svg)](https://github.com/AnjaliSharma1234/)
Binary file added assets/mobile-web.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/mobile-web_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.