- When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
- Fork this repo.
- Clone the forked repo.
- Make changes to the code.
- Commit the changes.
- Push the changes to the forked repo.
- Create a pull request.
- and done...will be reviewed soon.
Below are the steps to follow to contribute to this project:
1. Fork this repository.
2. Clone your forked copy of the project.
git clone https://github.com/<your_user_name>/gaurang.git
where your_user_name is your GitHub username.
3. Navigate to the project directory.
cd gaurang
4. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/gn009/gaurang.git
5. Check the remotes for this repository.
git remote -v
6. Always take a pull from the upstream repository to your main branch to keep it at par with the main project(updated repository). Feel free to raise new issues.
git pull upstream main
7. Create a new branch.
git checkout -b <your_branch_name>
8. Make necessary changes and commit those changes
9. Track your changes.
git add .
10. Commit your changes .
git commit -m "bla bla bla"
11. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>
12. To create a pull request, click on Compare & pull request. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.
13. Add appropriate title and description to your pull request explaining your changes and efforts done.
14. Click on Create pull request.
15. And you are done creating a pull request to this project. Be patient while your PR is reviewed.
- This repository is actively accepting contributions to hacktoberfest 2022
- For a contribution to count towards hacktoberfest it must be significant:
- For a README.md contribution to count it must be more than two paragraphs and contain significant information about the project
- Programming contributions should solve at least one file or one function
- Contributions that solve an existing issue will also be accepted as long as the issue is more than just a typo
Please note we have a code of conduct, please follow it in all your interactions with the project.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
- 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.
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
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.
- 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.
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting at gaurangnakum09@gmail.com. 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.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4