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
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Contribution guidelines

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

## Workflow

Our project uses the [GitHub Flow](https://guides.github.com/introduction/flow/index.html)

The steps to make your first contribution to this project are as follows :

1. Fork the repo and create your branch from master.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

## 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 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
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ More details will be added soon.

Do ⭐ this repo.

## Contributing
- Refer to the [Contributing Guidelines Document](https://github.com/MadhavBahlMD/my-open-profile/blob/master/CONTRIBUTING.md) for tips to make a contribution.

## Design

I have added a rough wireframe in `/designs/` folder
Expand All @@ -21,4 +24,4 @@ See the design here - [./designs/main_design.png](./designs/main_design.png)
Special thanks to the following Adobe XD UI kits for inspiration/components

1. material design ui kit.
2. [Free dashboard UI kit](https://www.behance.net/gallery/60714355/FREE-Dashboard-UI-Kit-for-Adobe-XD)
2. [Free dashboard UI kit](https://www.behance.net/gallery/60714355/FREE-Dashboard-UI-Kit-for-Adobe-XD)