Skip to content

Latest commit

 

History

History
138 lines (84 loc) · 5.5 KB

CONTRIBUTING.md

File metadata and controls

138 lines (84 loc) · 5.5 KB

✨ Contributing to this project

First of all, thanks for taking the time to contribute! 🎉👍

💣 Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports. 🔎

Since the new GitHub Issue forms, we only suggest you include the most information possible. But you can also Perform a cursory search to see if the report/request has already been raised. If it has, adds a comment to the existing issue instead of opening a new one.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

How Do I Submit A (Good) Bug Report?

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots or animated GIFs which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps, use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.

🛠 Suggesting Enhancements

Feature requests are tracked as GitHub issues. Create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a in detail description of the suggested enhancement in as many details as possible.
  • Explain why this enhancement would be useful to the website and the community.

📝 Cloning the project & creating PR

Fork the repository.

Click on the fork button on the top of the page. This will create a copy of this repository in your account. Instead click here to fork the repository.

Clone the forked repository.

 git clone https://github.com/<your-username>/4c-site.git

or if use the github cli

gh repo clone <your-username>/4c-site

Navigate to the project directory.

cd 4c-site

Create a new branch (naming convention: type-description-issueNo)

Kindly give your branch a more descriptive name like docs-contributing-guide-2 instead of patch-1.

You could follow this convention. Some ideas to get you started:

  • Feature Updates: feat-<brief 2-3 words-Description>-<ISSUE_NO>

  • Bug Fixes: fix-<brief 2-3 words-Description>-<ISSUE_NO>

  • Documentation: docs-<brief 2-3 words-Description>-<ISSUE_NO>

  • And so on...

To create a new branch, use the following command:

git checkout -b your-branch-name

Make the necessary changes.

Stage your changes and commit.

git add . # Stages all the changes
git commit -m "<your_commit_message>"

Your commit message should be something which gives concise idea of the issue you are solving.

We implement the Conventional Commits specification for commit messages. This specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.

The commit message should be structured as follows:

<type>(optional scope): <description>

If you are not sure about how to structure your commit message, you can use the following command:

npm run commit

Push your local commits to the remote repository.

git push origin your-branch-name

8. Create a new pull request from your-branch-name

🎉 Congratulations! You've made your first pull request! Now, you should just wait until the maintainers review your pull request.

✨ Understanding the project

The project is divided into two main folders:

  • src - This folder contains all the code related to the website.
  • docs - This folder contains everything related to the 4C community

src folder

The src folder contains all the code related to the website. The website is built using Next.js, a React framework. The website is hosted on Vercel.

The source code is divided into two main folders:

  • pages - This folder contains all the pages of the website.
  • components - This folder contains all the components of the website.

I suggest you to read the Next.js documentation to understand the project structure.

To run the website locally, you need to install the dependencies and run the development server:

npm i -g yarn # Install yarn
yarn # Install dependencies
yarn dev # Run the development server

docs folder

This folder contains markdown files describing the design of the main website and some detail about the 4C community