From b23d52b66cdd41d14aad48be1a83176d16c32d04 Mon Sep 17 00:00:00 2001 From: janusjerom Date: Sun, 25 Oct 2020 01:15:16 +0530 Subject: [PATCH] contributing guidelines --- CONTRIBUTING.md | 172 +++++++++++++++++++++++++++++++++++++++++++++++- README.md | 2 +- 2 files changed, 171 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8baa7ef..5bc6c8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,8 +4,6 @@ After cloning this repo open the project folder in a _text-editor_(vs code is preferable). If you don't have vs-code in your machine, [install it](https://code.visualstudio.com/download) -All [pull requests](contributing/PULL-REQUESTS.md) will require you to ensure the change is certified via the [Developer Certificate of Origin (DCO)](https://github.com/apps/dco/). The DCO is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. - ## Pull Request Process 1. Fork the repository. @@ -13,3 +11,173 @@ All [pull requests](contributing/PULL-REQUESTS.md) will require you to ensure th 3. Submit a pull request. 4. Handle any feedback before the request is merged. 5. Accept our sincere Thank You! + +### Folder Structure + +``` +├───C +├───C++ +├───Java +├───Javascript +├───Other +└───Python + +``` +All the file you code should be created inside their respective programming language folder. + +### How to make necessary changes and commit those changes + +Make changes based on what code snippet you are adding. +For example : You are coding a program to print 'Hello World!' in C Programming Language + +```c +// PROGRAM-NAME : Print 'Hello World' ! +// By John Doe + +//PROGRAM-CODE : +#include + +int main(void) +{ + printf("Hello World !\n"); + return 0; // ends the program +} +``` + +### Create a branch + +Change to the repository directory on your computer (if you are not already there): + +``` +cd HacktoberFest-2020 +``` + +Now create a branch using the `git checkout` command: + +``` +git checkout -b +``` + +For example: + +``` +git checkout -b add-john-doe +``` + +(The name of the branch does not need to have the word _add_ in it, but it's a reasonable thing to include because the purpose of this branch is to add your name to a list.) + +## Now commit these changes + +If you go to the project directory and execute the command git status, you'll see there are changes. +Add those changes to the branch you just created using the `git add` command: + +``` +git add . +``` + +Now commit those changes using the `git commit` command: + +``` +git commit -m "Added new " +``` + +## Push changes to github + +Push your changes using the command `git push`: + +``` +git push origin +``` + +replacing `` with the name of the branch you created earlier. + +## Submit your changes for review + +If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. +Now submit the pull request. +Soon I'll be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged. + +create a pull request + +Now submit the pull request. + +submit pull request + +## PLEASE NOTE + +When contributing a major change to this repository, please first discuss the change you wish to make via an [issue](contributing/ISSUES.md) or via +[Slack in the #droneaid channel](https://code-and-response.slack.com/join/shared_invite/enQtNzUzOTAzNDE3MTM4LWM4M2VlOTA3OWNjMjY0ZTI4MjQ2OTBjYjYwNmQ1NTdhYjZhODE5NjFkN2QyNmRkNDI5OTFlZmVjYTFhMmMwYmU). Minor issues can simply be addressed by sending by a pull request. + +All [pull requests](contributing/PULL-REQUESTS.md) will require you to ensure the change is certified via the [Developer Certificate of Origin (DCO)](https://github.com/apps/dco/). The DCO is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. + +Please note we have a [Code of Conduct](#code-of-conduct), please follow it in all your interactions with the project and its community. + +## 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 + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team on [Slack in the #droneaid channel](https://code-and-response.slack.com/join/shared_invite/enQtNzUzOTAzNDE3MTM4LWM4M2VlOTA3OWNjMjY0ZTI4MjQ2OTBjYjYwNmQ1NTdhYjZhODE5NjFkN2QyNmRkNDI5OTFlZmVjYTFhMmMwYmU). + +All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ +All [pull requests](contributing/PULL-REQUESTS.md) will require you to ensure the change is certified via the [Developer Certificate of Origin (DCO)](https://github.com/apps/dco/). The DCO is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. diff --git a/README.md b/README.md index c551b05..11ddd5f 100644 --- a/README.md +++ b/README.md @@ -101,4 +101,4 @@ Soon I'll be merging all your changes into the master branch of this project. Yo Now submit the pull request. -# *Happy Coding* +# ** *Happy Coding* **