-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #250 from Veerhan-glitch/Chore-Contributing-guidel…
…ines Update CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
85 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,86 @@ | ||
| <h2>Contributing to OpenWeightlifting</h2> | ||
| Adding value to OpenWeightlifting is as simple as this: | ||
| # Contributing to OpenWeightlifting | ||
|
|
||
| 1. Always fork from the development branch. | ||
| 2. Always open PRs to development branch. | ||
| 3. If the PR is in relation to an issue/feature then it must be stated within the PR. | ||
| 4. TODO comments are fine but an issue must recorded when doing so. | ||
| Thank you for considering contributing to OpenWeightlifting! | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Code of Conduct](#code-of-conduct) | ||
| - [Getting Started](#getting-started) | ||
| - [For PR](#for-pr) | ||
| - [For Issue](#for-issue) | ||
| - [Contributing Guidelines](#contributing-guidelines) | ||
| - [Code Style](#code-style) | ||
| - [Variable Names](#variable-names) | ||
| - [Documentation](#documentation) | ||
| - [Testing](#testing) | ||
| - [Submitting a Pull Request](#submitting-a-pull-request) | ||
| - [Spam and Invalid Contributions](#spam-and-invalid-contributions) | ||
| - [Contact](#contact) | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| Before you start contributing, please read and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to follow these guidelines to maintain a respectful and welcoming community. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Rmember to read [code of conduct](./code_of_conduct). | ||
| 2. [Discord]("TODO: add a link to discord") to be used for discussions. | ||
|
|
||
| ### For PR | ||
|
|
||
| 1. Fork the repository to your own GitHub account. | ||
| 2. Clone your forked repository to your local machine. | ||
| 3. Create a new branch for your work with a proper well defined name (see [Branches naming convention](#branches-naming-convention)). | ||
| 4. Make your changes and commit them with meaningful commit messages. | ||
| 5. Open [PRs](https://github.com/euanwm/OpenWeightlifting/pulls) to development branch (Remember to [Squash](https://docs.github.com/en/desktop/managing-commits/squashing-commits-in-github-desktop) before making a pr). | ||
| 6. If the PR is in relation to an issue/feature then it must be referenced within the PR. | ||
| 7. TODO comments are fine but an issue must recorded when doing so. | ||
| 8. Tests are not strictly required but nice to have. | ||
|
|
||
| #### Branches naming convention: | ||
| - feature/<branch-name> for new feature implementations | ||
| - fix/<branch-name> for broken code, build and/or bug fixes | ||
| - chore/<branch-name> for non-breaking & non-fixing code changes such as linting, formatting, etc. | ||
|
|
||
| ### For Issue | ||
|
|
||
| 1. [Issues](https://github.com/euanwm/OpenWeightlifting/issues) can be raised but templates must be followed. | ||
|
|
||
| ## Contributing Guidelines | ||
|
|
||
| ### Code Style | ||
|
|
||
| - Follow consistent code style throughout the project. | ||
| - Use indentation with 4 spaces. | ||
| - Use clear and descriptive variable and function names. | ||
| - Comment your code where necessary to explain complex logic. | ||
|
|
||
| ### Variable Names | ||
|
|
||
| - Use meaningful and descriptive variable names. | ||
| - Avoid single-letter variable names unless they are for loop counters. | ||
|
|
||
| ### Documentation | ||
|
|
||
| - Ensure that your code is well-documented. | ||
| - Include comments to explain the purpose and usage of functions and classes. | ||
| - Update the [README.md](./README.md) file if your changes introduce new features or modify existing ones. | ||
|
|
||
| ### Testing | ||
|
|
||
| - Tests are not strictly required but nice to have. | ||
|
|
||
| ## Submitting a Pull Request | ||
|
|
||
| 1. Push your changes to your forked repository. | ||
| 2. Create a pull request from your forked repository to the development branch of this repository on GitHub. | ||
| 3. Ensure that your pull request includes a clear description of the changes made and their purpose. | ||
| 4. Our team will review your pull request and provide feedback or merge it if everything looks good. | ||
|
|
||
| ## Spam and Invalid Contributions | ||
|
|
||
| Spammy or invalid contributions will not be tolerated. We take the quality of our project seriously. If your contributions are identified as spam or invalid, they will be marked accordingly. Please ensure that your contributions align with our guidelines and benefit the project. | ||
|
|
||
| ## Contact | ||
|
|
||
| If you have any questions or need further assistance, feel free to reach out to us on our [Discord] ("TODO: add a link to discord") to be used for discussions. |