-
Notifications
You must be signed in to change notification settings - Fork 124
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
434afa7
commit 18102bb
Showing
1 changed file
with
93 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
# **Contributing Guidelines** 📄 | ||
|
||
This documentation contains a set of guidelines to help you during the contribution process. | ||
We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. | ||
Thank you for helping out and remember, **no contribution is too small.** | ||
<br> | ||
Please note we have a [code of conduct](CODE_OF_CONDUCT.md) please follow it in all your interactions with the project. | ||
|
||
|
||
|
||
<br> | ||
|
||
## **Need some help regarding the basics?🤔** | ||
|
||
|
||
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, | ||
in case you are stuck: | ||
|
||
- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) | ||
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) | ||
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) | ||
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) | ||
- [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources) | ||
|
||
<br> | ||
|
||
## **Issue Report Process 📌** | ||
|
||
1. Go to the project's issues. | ||
2. Give proper description for the issues. | ||
3. Don't spam to get the assignment of the issue 😀. | ||
4. Wait for till someone is looking into it !. | ||
5. Start working on issue only after you got assigned that issue 🚀. | ||
|
||
<br> | ||
|
||
# Steps to Contribute 👨💻 | ||
|
||
**Give this project some love! Star⭐ the repo and follow @PranavBarthwal to stay in the loop.** | ||
|
||
1. **Fork the Repository:** To make a copy of the repository in your GitHub account, click the "Fork" button located in the top right corner of the project repository page. | ||
|
||
2. **Clone the Forked Repository:** Clone the repository to your local development environment by opening the terminal or command prompt and executing the following command: | ||
|
||
``` | ||
git clone https://github.com/<your-github-username>/cosmoXplore.git | ||
``` | ||
|
||
3. **Navigate to your repository:** Navigate to your new project directory by using the command: | ||
|
||
``` | ||
cd cosmoXplore | ||
``` | ||
|
||
4. **Create a New Branch:** Establish a new branch for your profile using the command: | ||
|
||
``` | ||
git checkout -b <branch_name> | ||
``` | ||
|
||
5. **Add Your Changes:** Add the modified files to the stage with the following command: | ||
|
||
``` | ||
git add . | ||
``` | ||
|
||
6. **Commit Your Changes:** Save your alterations to the branch by executing: | ||
|
||
``` | ||
git commit -m "Your descriptive commit message" | ||
``` | ||
|
||
7. **Push to the Branch:** Transmit the changes to the remote repository using: | ||
|
||
``` | ||
git push origin <branch_name> | ||
``` | ||
|
||
8. **Create a Pull Request:** Submit your modifications to the main repository by generating a pull request. Click on the "Compare & pull request" button on your forked repository page. | ||
|
||
9. **Wait for Review and Merge:** Wait for the project maintainers to review and merge your changes. | ||
|
||
## **Pull Request Process 🚀** | ||
|
||
1. Ensure that you have self reviewed your code 😀 | ||
2. Make sure you have added the proper description for the functionality of the code | ||
3. I have commented my code, particularly in hard-to-understand areas. | ||
4. Add screenshot it help in review. | ||
5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀 | ||
|
||
<br> | ||
|
||
# **Thank you for contributing💗** |