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

Create Readme.md #14

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

Please adhere to the contribution guidelines for obtaining the hacktoberfest-accepted tag.

## How can you participate?

- Tackle one of our [open issues](https://github.com/Developer-Student-Clubs-VSSUT-Burla/Compose_Circles_App/issues)
- Submit your [file](https://github.com/Developer-Student-Clubs-VSSUT-Burla/Compose_Circles_App/issues/9)
- Mention all the [asset](https://github.com/Developer-Student-Clubs-VSSUT-Burla/Compose_Circles_App/tree/main/assets) and packages used in the file.
- Mention the issue number in the comment as `issue #3 resolved`.

## Steps For Contribution

Star this repository ⭐

Fork this repository.

1. Clone the forked repository.

```markdown
git clone https://github.com/<your-github-username>/Hacktoberfest-2022
```

2. Navigate to the project directory.

```markdown
cd Hacktoberfest-2022
```

3. Create a new branch.

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

4. Make changes.
Stage your changes and commit

```markdown
git add -A
git commit -m "<your_commit_message>"
```

Push your local commits to the remote repo.

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

Create a Pull Request.

Congratulations! 🎉 you've made your contribution.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Compose Circle App :
GDSC-VSSUT X Hacktoberfest brings you an unprecedented opportunity to develop a **COMMUNITY APP** that will enable you to keep track of upcoming hackathons, competitive programming and open source contests.

Let’s popularize open source with #Hacktoberfest a month-long carnival of open source projects, their maintainers and the entire community of contributors.

If you are a developer keen to find solutions for real-world problems then do come forward and be a part of the project.

##

## Features
* Find Hackathons, competative programming contests and Open-Source contests
* Find teammates based on their skills
* Profile management
* Event details and registrations
* Support & Chat Box for connecting with people

## What is Hacktoberfest?
Hacktoberfest is an annual festival hosted by DigitalOcean that takes place in the month of October to celebrate the open source community. As part of this 31-day celebration, contributors and open source maintainers are encouraged to work on open source projects and win swag to mark the occasion.

## Ready to make a contribution?
If you’re working on an open issue, read the CONTRIBUTING.MD file in the repo to get specific guidelines on how to work on this repo.
Ask to be assigned to that issue before you start working on it.

## Files and Assets
All the assests required for creating the UI are available in the assets directory. Please strictly adhere to the designs provided.

## Join us on Discord!

🔗 [GDSC VSSUT](https://discord.gg/uZXYWNm4)

🤝 Get help from the community and GDSC team in the [#your_queries](https://discord.com/channels/759999287261397082/760010412585910303) channel

🚀 Show the community what you’ve been working on in the [#open_source](https://discord.com/channels/759999287261397082/761974085851938876) channel

💬 Share and pick up tips and trick in the [#general_chat](https://discord.com/channels/759999287261397082/760010375252017203) channel

💡 Tell us about your experience building with JetPack Compose in [#app-dev](https://discord.com/channels/759999287261397082/760018608712974337) channel