|
1 | | -# First Contribution |
2 | | -<p>This project is for those who are new to open-source and looking for make their first contribution.<p> |
3 | | -<p>Follow the steps below :- </p> |
| 1 | +# Contributing |
4 | 2 |
|
5 | | -*** |
| 3 | +When contributing to this repository, please first discuss the change you wish to make via issue, with the maintainers of this repository before making a change. |
6 | 4 |
|
7 | | -# Git Setup Guide |
8 | | -## To initialise Git, write |
9 | | -```bash |
10 | | -git init |
11 | | -``` |
| 5 | +First time contributers can refer to various resources on how |
| 6 | +to make their first contribution, one which we would refer is [this.][first] |
12 | 7 |
|
13 | | -## 1. Configure your local Git |
14 | | -```bash |
15 | | -git config --global user.name "github username" |
16 | | -``` |
| 8 | +Please note we have a code of conduct, please follow it in all your interactions with the project. |
17 | 9 |
|
18 | | -```bash |
19 | | -git config --global user.email "email address" |
20 | | -``` |
| 10 | +## Pull Request Process |
21 | 11 |
|
22 | | -## 2. Go to the first-contribution repository and Fork it. |
23 | | -* A fork is a rough copy of a repository. Forking a repository allows you to freely test and debug with changes without affecting the original project. One of the excessive use of forking is to propose changes for bug fixing. |
| 12 | +1. Fork the repository and add a new file with a name that |
| 13 | +describes your script in short to put your scripts there. |
| 14 | +2. Add a `README.md` in that file which explains your script |
| 15 | +and any prerequisites. |
| 16 | +3. Update the main `README.md` with details of changes to the interface, this includes your script, link to it and a small |
| 17 | +description. |
| 18 | +4. Mention the issue in your Pull Request, which will be then verified and merged accordingly. |
| 19 | +5. Ensure any install or build dependencies are removed before the end of the layer when doing a build. |
24 | 20 |
|
25 | | - |
26 | | -* Click on Code Button and copy the URL of your forked Repository |
| 21 | +--- |
| 22 | +## Code of Conduct |
27 | 23 |
|
28 | | - |
29 | | -## 3. Switch to your Git bash window, and enter the following : |
| 24 | +### Our Pledge |
30 | 25 |
|
31 | | -* Clone the Forked project on your local system |
| 26 | +In the interest of fostering an open and welcoming environment, we as |
| 27 | +contributors and maintainers pledge to making participation in our project and |
| 28 | +our community a harassment-free experience for everyone, regardless of age, body |
| 29 | +size, disability, ethnicity, gender identity and expression, level of experience, |
| 30 | +nationality, personal appearance, race, religion, or sexual identity and |
| 31 | +orientation. |
32 | 32 |
|
| 33 | +### Our Standards |
33 | 34 |
|
| 35 | +Examples of behavior that contributes to creating a positive environment |
| 36 | +include: |
34 | 37 |
|
35 | | -* Make the changes |
| 38 | +* Using welcoming and inclusive language |
| 39 | +* Being respectful of differing viewpoints and experiences |
| 40 | +* Gracefully accepting constructive criticism |
| 41 | +* Focusing on what is best for the community |
| 42 | +* Showing empathy towards other community members |
36 | 43 |
|
| 44 | +Examples of unacceptable behavior by participants include: |
37 | 45 |
|
38 | | -## 4. Creating a Pull request |
39 | | -### Create a branch |
| 46 | +* The use of sexualized language or imagery and unwelcome sexual attention or |
| 47 | +advances |
| 48 | +* Trolling, insulting/derogatory comments, and personal or political attacks |
| 49 | +* Public or private harassment |
| 50 | +* Publishing others' private information, such as a physical or electronic |
| 51 | + address, without explicit permission |
| 52 | +* Other conduct which could reasonably be considered inappropriate in a |
| 53 | + professional setting |
40 | 54 |
|
41 | | -* A branch is designed to encapsulate a group of changes. These changes might be thrown away, entirely rewritten or in the majority of cases they’ll be promoted into the main history of the codebase - via a merge. |
| 55 | +### Our Responsibilities |
42 | 56 |
|
| 57 | +Project maintainers are responsible for clarifying the standards of acceptable |
| 58 | +behavior and are expected to take appropriate and fair corrective action in |
| 59 | +response to any instances of unacceptable behavior. |
43 | 60 |
|
44 | | -* Creating a branch |
| 61 | +Project maintainers have the right and responsibility to remove, edit, or |
| 62 | +reject comments, commits, code, wiki edits, issues, and other contributions |
| 63 | +that are not aligned to this Code of Conduct, or to ban temporarily or |
| 64 | +permanently any contributor for other behaviors that they deem inappropriate, |
| 65 | +threatening, offensive, or harmful. |
45 | 66 |
|
46 | | -```bash |
47 | | -git branch branch_name |
48 | | -``` |
| 67 | +### Scope |
49 | 68 |
|
50 | | -* Checkout to the created branch |
| 69 | +This Code of Conduct applies both within project spaces and in public spaces |
| 70 | +when an individual is representing the project or its community. Examples of |
| 71 | +representing a project or community include using an official project e-mail |
| 72 | +address, posting via an official social media account, or acting as an appointed |
| 73 | +representative at an online or offline event. Representation of a project may be |
| 74 | +further defined and clarified by project maintainers. |
51 | 75 |
|
52 | | -```bash |
53 | | -git checkout branch_name |
54 | | -``` |
| 76 | +### Enforcement |
55 | 77 |
|
| 78 | +Instances of abusive, harassing, or otherwise unacceptable behavior may be |
| 79 | +reported by contacting the project team at [INSERT EMAIL ADDRESS]. All |
| 80 | +complaints will be reviewed and investigated and will result in a response that |
| 81 | +is deemed necessary and appropriate to the circumstances. The project team is |
| 82 | +obligated to maintain confidentiality with regard to the reporter of an incident. |
| 83 | +Further details of specific enforcement policies may be posted separately. |
56 | 84 |
|
57 | | -* Now add the files using the git command |
| 85 | +Project maintainers who do not follow or enforce the Code of Conduct in good |
| 86 | +faith may face temporary or permanent repercussions as determined by other |
| 87 | +members of the project's leadership. |
58 | 88 |
|
59 | | -```bash |
60 | | -git add . |
61 | | -``` |
62 | | -* Commit the changes to the local project |
63 | | - |
64 | | -```bash |
65 | | -git commit -m "Added my data" |
66 | | -``` |
67 | | - |
68 | | -* Push the changes to your forked github repo |
69 | | -```bash |
70 | | -git push origin branch_name |
71 | | -``` |
72 | | - |
73 | | -## 5. Final Steps |
74 | | -* Open your forked git repository, you will get a message like as shown in the figure (if not then refresh the page). |
75 | | - |
76 | | -- Click on "Contribute" |
77 | | -- Now click on "Open pull request" |
78 | | -- Click on "Create pull request" |
79 | | -- Click on "Create pull request" |
80 | | -- You will get message which says that you have sucessfully made a pull request ! |
81 | | - |
82 | | - |
83 | | - |
| 89 | +### Attribution |
84 | 90 |
|
| 91 | +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, |
| 92 | +available [here.][version] |
85 | 93 |
|
| 94 | +[homepage]: http://contributor-covenant.org |
| 95 | +[version]: http://contributor-covenant.org/version/1/4/ |
| 96 | +[first]: https://dev.to/diballesteros/step-by-step-guide-for-the-first-time-open-source-contribution-48bo |
0 commit comments