Skip to content

Latest commit

 

History

History
248 lines (185 loc) · 16 KB

CONTRIBUTING.md

File metadata and controls

248 lines (185 loc) · 16 KB
Raw

Contributing to alfirman.dev

How to contribute

In this project, we are heavily utilising GitHub features to document and signal any progress in the website development.

Finding or creating issues

Most contributions start from defining issues. Anyone can open an issue for discussion. You can head to this link for deep understanding about Issues. Specifically, you can start finding several Issues in our Issues tab. There are only two categories in Issues section, Open and Closed.

Open Issues

Open Issues are issues that need more attention and need to be resolved. Contributors should pick any of the Open Issues and start working on them.

Closed Issues

Closed Issues are issues that have been completed or doesn't need further action. Closed issues can be reopened if contributors find any issues related to it sometime in the future.

Please pay attention on every issue attribute. Every issue might be referenced by other contributors through Linked Pull Requests. If an issue has a linked pull request, that means the issue is currently being handled. To avoid working on the same issue, contributors were strongly encouraged to submit a draft pull request first when they start working on an issue.

For Beginners: good first issue label

As mentioned here, good first issue is a label feature from GitHub which created to help beginner contributors in contributing to an open-source project. good first issue informed us about the difficulty level of an issue. This means that an issue with good first issue label suits perfectly for contributors that would like to have their first contribution to an open-source project.

How to find issues with good first issue label:

  1. The easiest way is to go into the github.com/<owner>/<repository>/contribute link. In this case, you can go into this link. That link will list all of the issues with the good first issue label.
  2. Another way is to head over into the Issues section of the repository, then click the Labels section beside Milestones. There you can see a lot of labels for the issues in the repository. Then find and click the good first issue label.

Working on issues

Getting ready

Before working on an issue, please make sure to:

  1. Fork the repo properly. Even you have done it before, it's still advised that you read / skim the official guide.
  2. Clone your forked repository and set it up by following the Getting Started guide.
  3. Check any open pull requests that no one is working on the issue.
  4. Create a new branch from the main branch.

Issue assignment & Communication

Once you're ready with your branch and have something to contribute, you'll want to let everyone know that you are working on the issue. To communicate this, we are using GitHub's Draft Pull Requests.

Draft Pull Request is like a regular Pull Request but it can't be merged until it's marked as "ready for review". It signals other contributors that it's a work in progress. This is necessary to signal other contributors that the work for the particular issue has started and it is still in progress. Also, it is a better approach to use as a communication tool between contributors because we can provide additional information other than viewing the changed files.

Therefore, when you have at least one commit it's important to create a Draft Pull Request to let everyone know that the issue is assigned to you.

Creating a Draft Pull Request

Steps to creating a Draft Pull Request:

  1. Commit and push your new changes into the remote repository. Please refer to @commitlint/config-conventional for your commit message or you can use commitlint.io to assist you in composing the commit message.
  2. Head over to the Pull requests section on your forked repository, hit New pull request. Hint-1
  3. Pick your forked repository for the head repository, and compare with the branch that you are having changes in. Hint-2
  4. Put a clear title and description in your pull request. Make sure the description follows our guide below. Hint-3
  5. Pick Create draft pull request (like in the image above) and hit the green button.
  6. Don't forget to mark your Draft Pull Request as Ready for review after you commit all of the changes.

Formatting Pull Request Description

To properly link a pull request to an issue, there is one tiny requirement text to put in a Pull Request description. Please make sure to mention the issue that you're working on correctly. Replace this text <!-- mention the issue that you're trying to close with this PR --> from the template with the issue number. Example:

Closes #318

## Description

Update **`Start working on Issues`** section with clearer instructions on getting ready to work on an issue.

Disabling GitHub Actions

We recommend contributors to disable GitHub action on your forked repository.

  1. Go to Setting on your forked repository
  2. Choose Action on sidebar
  3. Disable Actions Disable-actions

FAQ

Why are we using English in our issues & PRs?

There are several reasons we're using English while communicating in GitHub Issues & PRs:

  1. It's more natural for software engineers to communicate in English because it involves many technical terms in English. Trying to translate them into Bahasa Indonesia posing a risk of miscommunication, while keeping them in English requires us to do a lot of italic formatting, according to PUEBI.
  2. It accustoms the contributors, which are mostly Indonesian, to communicate in English. It is important to increase our English reading and writing skills because the vast majority of the global open-source communities are using Engish as the main language.
  3. It makes this project easier to be recognised globally. So if we need to get more support from the global communities, they could easily understand what we are doing and help us out with their access and competence. e.g., providing us free credits for their services, advocating us to global leaders, or contributing directly to our codebase.

Additional Notes

Commitlint

In a repository with many contributors like this, it's important to understand what's going on in it and navigate between commits. Moreover, with various levels of contributors & their backgrounds, the commit messages can easily be confusing and the structure may follow different approaches.

To overcome these issues, the maintainers adopt commit conventions to allow contributors to add more semantic meaning to our git history. They use commitlint to lint the git commit messages. To enforce the conventions, the maintainers use a git hook to run the commitlint upon a git commit command. The git hook prevents the commit the staged files if the commit message failed to comply with the conventions.

It's adviseable to read the commit conventions briefly to further understand the other benefits from them. However, if you're having problems with it, you can use this tool to help.

Furthermore, please refer to the list of commit types and scopes that we use to avoid adding a new scope that has similar meaning or is synonym to the existing one.

References

Conventional Commits

The convention specification looks like this:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Commit types

Here are what we use for the commit types:

  • build
  • chore
  • docs
  • feat
  • fix
  • perf
  • refactor
  • style
  • test

Commit scopes

Here are what we use for the scopes:

  • assets
  • ci
  • cms
  • components
    • donasi
    • education
    • home
    • json-ld
    • kontak-darurat
    • layout
    • telemedicine
  • cypress
  • deps
  • dx
  • e2e
  • fetcher
  • pages
    • faq
    • isoman
  • security
  • seo
  • ui

Note: If there's a second level in a list, only the lowest level gets to be used.

Issue and Pull Request Labels

Issue labels are a tool to group issues into one or more categories. It helps us track and manage issues and pull requests.

Please open an issue on alfirmanpahlepi/alfirman.dev if you have suggestions for new labels.

Type of Issue and Issue State

Label name /alfirman.dev. Description
blocked search Issues blocked by something else.
bug search Confirmed bugs or reports that are very likely to be bugs.
enhancement search New feature or request.
epic search A master issue thread which contains other smaller issues.
good first issue search Less complex issues which would be good first issues to work on for users who want to contribute to alfirman.dev.
help wanted search Issue that need extra attention.
invalid search Issues which aren't valid (e.g. user errors).
question search More information needs to be collected about these problems or feature requests (e.g. steps to reproduce).
wontfix search The alfirman.dev team will not fix these issues for now.

Topic Categories

Label name /alfirman.dev. Description
ci-cd search Continuous Integration & Continuous Delivery.
design search Issue related to design.
documentation search Improvements or additions to documentation.
dx search Developer Experience.
ui search User interface.
ux search User experience.
seo search Search engine optimization.
scripting search Issue related to the code.
testing search Automated testing.
netlify-cms/draft search Draft for content changes in Netlify CMS.
netlify-cms/pending_publish search Content changes ready to be published through Netlify CMS.
netlify-cms/pending_review search Content changes pending review in Netlify CMS.