diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..0bf3683 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,42 @@ + +### Please confirm this pull request meets the following requirements: + +- [ ] I followed the contributing guidelines: . + +### Which change are you proposing? + + - [ ] Adding/updating open source project/s + - [ ] Adding/updating maintainer/s + +--- + + +### Adding/updating open source project/s + +- [ ] The project was built in or receives significant contributions from India +- [ ] The project has at least 100 stargazers + +**Why should this open source project be featured?** + +> Please replace this line with an explanation of why you think these changes should be made. + + +### Adding/updating maintainer/s + +- [ ] Maintainer's location on their GitHub profile indicates as India +- [ ] Maintainer has approved this PR to be included on the website + +**What open source project/s does the individual maintain?** + +> Please replace this line with GitHub URLs to projects that the individual/s maintains + + +### Something that does not neatly fit into the binary options above + +- [ ] My suggested edits are not about an existing page, or at least not a single one + +> Please replace this line with an explanation of your proposed changes. + +--- + +**Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.** \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1d71fb7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# Welcome to GitHub India contributing guide + +Thank you for investing your time in contributing! Contributions that you make under the `website` directory will be reflected on [githubindia.com](https://githubindia.com) :sparkles:. + +Your contributions would help the community discover valuable information. + +Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. + +## Types of contributions + +We currently accept contributions only for select content on [githubindia.com](https://githubindia.com). The content for this is located under the `website` directory of this repo. + +## Guidelines + +githubindia.com website is intended to showcase the open source ecosystem in India, and help discover open source projects and maintainers. + +- Only repository names, project categories, maintainer GitHub usernames, and maintainer locations can be edited. Other information like stargazers, descriptions, followers, etc are updated periodically from GitHub's public API. +- For new maintainers added, PR reviews are requested from those maintainers for approval to be added on the website. +- Maintainer locations need to match the location on their public GitHub profile. +- Please fill out the pull request template completely. If you do not fill out the template, your pull request will be closed. +- Please limit your pull request to updating one page at a time. For maintainer updates, please limit to 5 maintainers in a PR. +- While we would love to showcase as many projects and maintainers as possible, we also want to keep the website valuable for all developers. GitHub team will use its judgement and discretion on PR approvals. + + +## Making Changes + +### Make changes in the UI + +Click **Edit this page** at the top of any page which accepts contributions. This takes you to the `.yml` file where you can make your changes and [create a pull request](#pull-request) for a review. + +### Make changes in a Codespace + +You can also make a change using GitHub Codespaces. For getting started with Codespaces, see "[Quickstart for GitHub Codespaces](https://docs.github.com/en/codespaces/getting-started/quickstart)." + +### Make changes locally + +1. Fork the repository. +- Using GitHub Desktop: + - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. + - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! + +- Using the command line: + - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. + +2. Create a working branch and start with your changes! + +3. Commit the changes once you are happy with them. + + +### Pull Request + +When you're finished with the changes, create a pull request, also known as a PR. +- Fill the Pull Request template so that we can review your PR. + +- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. +Once you submit your PR, a GitHub team member will review your proposal. We may ask questions or request for additional information. +- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. +- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). +- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues. + +### Your PR is merged! + +Congratulations :tada::tada: The GitHub team thanks you :sparkles:. + +Updates won't immediately appear once we've merged your PR. We pull in these changes regularly to githubindia.com. + diff --git a/website/README.md b/website/README.md index e69de29..ebc42c7 100644 --- a/website/README.md +++ b/website/README.md @@ -0,0 +1,5 @@ +# GitHubIndia.com + +This directory hosts content that is served on [githubindia.com](https://githubindia.com). + +For contributing to the content, check out [CONTRIBUTING.md](../CONTRIBUTING.md) \ No newline at end of file diff --git a/website/docs/CONTRIBUTING.md b/website/docs/CONTRIBUTING.md deleted file mode 100644 index e69de29..0000000