Skip to content
This repository has been archived by the owner on Mar 28, 2024. It is now read-only.

πŸš€ A repository to encourage beginners to contribute to open source and for all contributors to view their Github stats

License

Notifications You must be signed in to change notification settings

subeshb1/developer-community-stats

Repository files navigation

πŸš€ Developer Community stats

Contributors Closed PR Stars License Issues Forks Contributor Country main-push-deploy-action

A repository to encourage beginners to contribute to open source and for all contributors to view their Github stats.

stats

Contributing to Developer Community stats

Contributing to Open issues and Challenges

The repository consists of Open issues encouraging beginners to take their first step to contribute to Open source. If you have any ideas regarding challenges, suggestions or feedback don't feel hesitant, create some issues.

When contributing to an issue be sure to read through the description and follow the steps and make sure all the builds in the PR succeed.

The most common contribution is adding yourself to contributors.json. See issue #8 on how to add your info and view your Github stats in https://developer-community-stats.netlify.app/.

Contributing to Core Website

The core website is built with Gatsby, React and Github Graphql API. Follow the following steps to contribute to the website

# Fork the repo
https://github.com/subeshb1/developer-community-stats

# Clone your forked repo
$ git clone [email protected]:username/developer-community-stats.git

$ npm install

# Create a new branch for you.
$ git pull origin main # Pull the latest main branch
$ git checkout -b new-branch # Checkout to your new branch

# Start Gatsby mock server
ENV_TYPE=mock gatsby develop

# To start Gatsby server with github token and url expose the following variables
GITHUB_GRAPHQL_URL=<github_graphql_url>
GITHUB_TOKEN=<your_personal_access_token>

# Run tests
$ npm run test

# Commit the changes
$ git commit -m "Commit message"

# Push your changes and
$ git push --set-upstream origin new-branch

# Make a pull request of your newly changed branch
[https://github.com/subeshb1/developer-community-stats/compare](https://github.com/username/developer-community-stats/compare)

Have some Suggestions or a new Idea?

Add your idea/suggestion in the IDEAS.md file.

License

MIT

Contributors