Skip to content
This repository was archived by the owner on Oct 9, 2025. It is now read-only.

docs: revise contributing guidelines #125

Merged
merged 3 commits into from
Sep 3, 2024
Merged

docs: revise contributing guidelines #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b4948d6
docs: revise contributing.md
dev-737 Aug 27, 2024
a586e67
Update CONTRIBUTING.md
dev-737 Sep 3, 2024
7ca650a
Update README.md
dev-737 Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 36 additions & 39 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,35 @@ We welcome contributions to InterChat! Whether you're fixing bugs, adding new fe

## Getting Started

1. **Fork the Repository:** Click on the "Fork" button in the top-right corner of this page.
2. **Clone Your Fork:** Use `git clone` to clone your forked repository to your local machine.
3. **Create a Branch:** It's good practice to create a new branch for each feature or bug fix:
Start by deciding *what* you’d like to contribute. A good place to begin is by browsing our [Issues](https://github.com/Discord-InterChat/InterChat/issues). Select one that aligns with your interests and skills.
Once you've chosen an issue, make your changes and submit a pull request for review. For more details on this process, refer to [GitHub’s contributing guide](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).

```sh
git checkout -b feature/new-feature
```
### Make Changes
Adhere to the project's coding conventions and style guides. If you're unsure, refer to existing code or ask for guidance.

## Making Changes

- **Follow Coding Standards:** Adhere to the project's coding conventions and style guides. If you're unsure, refer to existing code or ask for guidance.
- **Include Tests:** If you're adding new features or fixing bugs, include tests to ensure your changes work as expected and don't break existing functionality.
- **Include Tests:** If you're adding new features or fixing bugs, include tests to ensure your changes work as expected and don't break existing functionality. (Ignore this step, for now)
- **Documentation:** Update the README.md and other relevant documentation if your changes affect how the bot is used or deployed.
- **Write Clear, Concise Commits:** Each commit should have a clear and concise message explaining what changes were made and why. Use semantic commit messages in your commit messages as it will make auto-releases and changelog updates easier.

[Examples](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716):
### Submit Your Changes

- `feat`: new feature for the user, not a new feature for build script
- `fix`: bug fix for the user, not a fix to a build script
- `docs`: changes to the documentation
- `style`: formatting, missing semi colons, etc; no production code change
- `refactor`: refactoring production code, eg. renaming a variable
- `test`: adding missing tests, refactoring tests; no production code change
- `chore`: updating grunt tasks etc; no production code change
- **Push Your Branch:** Push your branch to your forked repository:

```sh
git cz
git push origin feature/new-feature
```

- **Open a Pull Request:** Go to the [original repository](https://github.com/Discord-InterChat/InterChat/pulls) and open a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) (PR) from your branch to the main branch. Include a detailed description of your changes and any relevant issues or discussions.

### Code Review

Your pull request will be reviewed by the maintainers. Please be responsive to feedback and ready to make necessary changes. Once approved, your changes will be merged into the main branch.

## Reporting Issues

If you encounter any issues or bugs, please report them by creating a [new issue](https://github.com/Discord-InterChat/InterChat/issues). Provide as much detail as possible, including steps to reproduce the issue and any relevant logs or screenshots.

## Extras
### Commitizen Friendly

To make our lives easier by not having to remember the commit messages at all times, this repository is [commitizen](https://www.npmjs.com/package/commitizen) friendly! Commitizen is a commandline tool that guides you through the process of choosing your desired commit type.
Expand All @@ -40,7 +44,18 @@ We welcome contributions to InterChat! Whether you're fixing bugs, adding new fe

Run `git cz` or `cz commit` to easily commit using commitizen.

## Special Comments

[Example Commit Messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716):

- `feat`: new feature for the user, not a new feature for build script
- `fix`: bug fix for the user, not a fix to a build script
- `docs`: changes to the documentation
- `style`: formatting, missing semi colons, etc; no production code change
- `refactor`: refactoring production code, eg. renaming a variable
- `test`: adding missing tests, refactoring tests; no production code change
- `chore`: updating grunt tasks etc; no production code change

### Special Comments

These are comments to show the state of a piece of code. Install the `Todo Tree` extension to highlight them in VS-Code.

Expand All @@ -52,27 +67,9 @@ These are comments to show the state of a piece of code. Install the `Todo Tree`

4. `NOTE` - A note left for later, something important or something that shows how something is supposed to be used/works.

## Submitting Your Changes

- **Push Your Branch:** Push your branch to your forked repository:

```sh
git cz
git push origin feature/new-feature
```

- **Open a Pull Request:** Go to the original repository and open a pull request (PR) from your branch to the main branch. Include a detailed description of your changes and any relevant issues or discussions.

## Code Review

Your pull request will be reviewed by the maintainers. Please be responsive to feedback and ready to make necessary changes. Once approved, your changes will be merged into the main branch.

## Reporting Issues

If you encounter any issues or bugs, please report them by creating a new issue in the GitHub repository. Provide as much detail as possible, including steps to reproduce the issue and any relevant logs or screenshots.

## Community

Join our [Discord server](https://interchat.fun/support) to connect with other contributors and discuss the project. Be respectful and follow the community guidelines.
Join our [Discord server](https://interchat.fun/support) to connect with other contributors and discuss the project. Please be respectful and follow our community guidelines.

Thank you for contributing to InterChat!
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center"><img src="https://i.imgur.com/MZiw1Yp.png" alt="interchat logo" width="150px"/></p>
<p align="center"><img src="https://github.com/user-attachments/assets/33f68c3a-67bc-4653-8578-2ab350ac3a75" alt="interchat logo" style="border-radius: 50%; width: 200px; height: 200px;"></p>

<p align="center"><strong>InterChat</strong></p>

Expand All @@ -7,24 +7,24 @@

This repo contains the source code for the InterChat Discord bot. InterChat is a Discord bot that allows you to chat with users from other servers.

# ❗Contributors Needed ❗
## ❗Contributors Needed ❗

InterChat is an open-source project that connects communities across Discord servers. We're on the lookout for passionate contributors to help us take this project to the next level!

## How You Can Help
### How You Can Help

- **Feature Development:** Help us build new features that make cross-server communication even more seamless.
- **Bug Fixes:** Assist in identifying and squashing bugs to enhance stability and performance.
- **Documentation:** Improve our documentation to make it easier for others to get involved and use InterChat.
- **Testing:** Contribute to testing new features and updates, ensuring everything works smoothly.

## I'm Interested! Where do I begin?
### I'm Interested! Where do I begin?

- Explore our [good first issues](https://github.com/Discord-InterChat/InterChat/contribute) to tackle beginner-friendly tasks or bug fixes.
- Or browse through all our [issues](https://github.com/Discord-InterChat/InterChat/issues) and pick one that catches your eye!
- Interested in improving our documentation/guides? Check out our [docs repository](https://github.com/Discord-InterChat/docs) and start contributing!

If you are unsure of the procedures, please refer our [Contributor Guidelines](./CONTRIBUTING.md) page. Thank you!
Please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines on how to contribute to this project. Thank you!

# Getting Started

Expand Down