Skip to content

Latest commit

 

History

History
109 lines (57 loc) · 3.49 KB

CONTRIBUTIONS.md

File metadata and controls

109 lines (57 loc) · 3.49 KB

<Repo> Logo

This file contains all the rules that you need to keep in mind while contributing to these projects.

Prerequisites 👇

  • Ability to use Git and Github :octocat:
  • Ability to understand the current codebase

Folder structure

.\<your-name> : Create a folder with your full name and make sure to put your entire code over there ( for assignments)

.\README.md : Add your name and github URL under the contributors section so that it can be shown to anyone who visits the repository

Contribution Guidelines

👇 Prerequisites:

  1. When it comes to package version, make sure you use the correct package.
  2. Improve Documentation, this really helps to understand code, mention all the error code along with their description while working on real projects.
  3. When it comes to naming convention, maintain similarity and stability through out the app.
  4. When it comes to scale our application, try using provider or something similar to that.
  5. Know well about advanced concepts in the domain you are contributing and try to use them properly.

Steps:

Steps

1. Fork [this](https://github.com/CodeAsylums-Community/) repository.

2. Clone the forked repository.

git clone https://github.com/<your-github-username>/<project name>

3. Navigate to the project directory.

cd <project name>

4. Create a new fodler for your name (assignment specific IGNORE FOR NORMAL PROJECTS).

5. Make changes in source code.

changes

6. Push your local branch to the remote repository.

git push origin main

7. Create a Pull Request!

Finally, go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your precious effort.

click on Compare and Pull Request

Congratulations! 💥 Sit and relax, you've made your contribution to project

Code of Conduct:

code_of_conduct

[Make sure you don't violate this](Enter link here!)

Project Maintainers and Mentors 👬

Code of Conduct

License 📝

Refer to LICENSE.