diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..abc9e955 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,86 @@ +# How to Contribute to Chayn ⭐ + +First off, thank you so much for taking the time to contribute! + +We ❀️ our volunteers! + +While Chayn is hybrid between paid staff and volunteers now, we cherish our volunteers for helping to create Chayn and keep us going! We hope to give back more than our contributors give. Please do not hesitate to give us feedback, so we can learn how to make this experience better for you. 😊 You can include feedback in your pull request, GitHub issues / discussions, or [this anonymous form](https://forms.gle/17GQpeHc4G1Mgdf3A). + +**This guide below assumes you are an open-source contributor and NOT an official Chayn volunteer that has already completed the onboarding process. If you would like to become an official tech volunteer with Chayn, please [visit our Getting Involved page](https://www.notion.so/chayn/Get-involved-423c067536f3426a88005de68f0cab19?pvs=4). As an official Chayn volunteer, you will receive professional onboarding onto our platforms and more opportunities to volunteer outside of GitHub contributions!** + +Next, let's get started... πŸŽ‰ + +## New Contributor Guide + +If you are new to GitHub and git version control, here are some resources to help you get started: + +- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) +- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) +- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) +- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) + +### What kind of contributions does Chayn want? + +Chayn is open to all kinds of contributions, such as: + +- no-code (improved documentation and translations) +- additional software tests +- code of any kind (enhancements and new features) + +Just no spamming (such as unwanted, minor documentation and HTML/CSS changes) please! + +## The Contribution Process: + +1. **Read the README and Code of Conduct:** To get an overview of the project, please read the project's [README](/README.md). Contributing means you have agreed to our [Code of Conduct](/CODE_OF_CONDUCT.md). + +2. **Create an issue or be assigned to an existing issue:** + + - If creating an issue, ensure that your issue doesn't already exist and to follow our issue templates. Please ask to be assigned your issue if you would like to work on it. + + - If you see an existing issue that interests you, please comment on it asking for the issue to be assigned to you. After the issue is assigned to you, you can start working on it! + + - Issues can be assigned to multiple people if everyone agrees to collaborate! + + - Consider if an issue would be best broken up into multiple, smaller issues. + + - If an assigned issue is abandoned, we will unassign the issue. Please do not hestitate to comment on an issue you can no complete, we understand life happens. We will tag you when the issue is unassigned to you. + + - Be sure to scan our issue `labels` to find issues that suit you: + + - The `good first issue` label is for problems or updates we think are ideal for beginners. + - The `moderate` label is for problems or updates that may take 1-2 days and will require some knowledge of the codebase. + - The `advanced` is for problems or updates that may take more time, say around 2-4 days. These will require more in-depth knowledge of the codebase. + + - We suggest starting with a `good first issue` to get comfortable with the codebase before moving on. + + **Feel free to ask clarifying questions in the issues discussions at any point during your contribution! We are happy to help!** + +3. **Fork the repo and create a new branch for your PR!** + +4. **Report progress and update your fork as needed:** + + - If your issue is more complex, feel free to report your progress by commenting on the issue or ticking off checkboxes in the issue description! + - If the original base repo is updated, it is recommended that you sync your fork with the base repo in order to prevent merge conflicts. + +5. **Commit and push your changes to your branch:** + + - Write brief comments explaining your code changes. + - Keep commits small, remember a PR can have multiple commits! + - Check that your tests pass. + - Run our linters to ensure uniform code formatting. + - Ensure that no secret tokens are being pushed to GitHub! Files containing secrets should be listed in `.gitignore` + - Write a [meaningful commit message](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/). + +6. **Submit your PR:** + + - Make sure to link your corresponding issue in your PR's description! + - Include detailed and concise explainations of the changes you made. + - Include images in the description, if applicable. + - 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 a maintainer can update the branch for a merge. + - Be available for discussions that may arise and to make [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) that may be required before merging. + +### Get merged and celebrate! πŸŽ‰ + +Woohoo! Once your PR is merged, your changes will be public on GitHub! + +Thank you for contributing to Chayn! πŸ‘ diff --git a/CONTRUBUTING.md b/CONTRUBUTING.md deleted file mode 100644 index 11a1f9f0..00000000 --- a/CONTRUBUTING.md +++ /dev/null @@ -1,74 +0,0 @@ -# Welcome to the Bloom contributing guide - -Thank you for investing your time in contributing to our project! - -Read our [Code of Conduct]([./CODE_OF_CONDUCT.md](https://www.notion.so/Code-of-Conduct-7b82ae6d100940ccbdac55c2ceec8644)) to keep our community approachable and respectable. - -In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. - -## New contributor guide - -To get an overview of the project, read the project's [README](README.md). Here are some resources to help you get started with open source contributions: - -- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) -- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) -- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) -- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) - - -## Getting started - -To navigate our codebase with confidence, see [this volunteer wiki]([/contributing/working-in-docs-repository.md](https://chayn.notion.site/Tech-volunteer-wiki-5356c7118c134863a2e092e9df6cbc34)) to get an idea of what kind of help we're looking for :confetti_ball:. - -Make sure you have been added to the `tech-volunteers` slack channel - you can ping any questions you have in this channel! If you haven't been added to slack, please message the team and we can add you. - -### Issues - -#### Create a new issue - -If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue. - -#### Solve an issue - -Scan through our existing issues to find one that interests you. You can narrow down the search using `labels` as filters. - -Labels can help you find an issue you'd like to help with. -- The `good first issue` label is for problems or updates we think are ideal for beginners. -- The `moderate` label is for problems or updates that may take 1-2 days and will require some knowledge of the codebase. -- The `advanced` is for problems or updates that may take more time, say around 2-4 days. These will require more in-depth knowledge of the codebase. - -We suggest starting with a `good first issue` to get comfortable with the codebase before moving on. - -As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. - -### Make Changes - -#### Make changes in the UI - -Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review. - -#### Make changes in a codespace - -For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)." - -### Commit your update - -Commit the changes once you are happy with them:zap:. - -### Pull Request - -When you're finished with the changes, create a pull request, also known as a PR. -- Please write a brief description of your PR and the problem it's solved. This helps reviewers understand your changes as well as the purpose of your pull request. -- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. -- 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 Chayn tech team member will review your proposal. We may ask questions or request 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 Chayn team thanks you :sparkles:. - -Once your PR is merged, your contributions will be publicly visible on Github. -