Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add additional rules and guidelines to contributing.md #147

Merged
merged 3 commits into from
Sep 3, 2024
Merged

Add additional rules and guidelines to contributing.md #147

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ae4031
Add additional rules and guidelines to contributing.md
samriddhi99 Jul 26, 2024
0267a38
Add examples for commit messages and guidelines for solving issues
samriddhi99 Jul 29, 2024
4183bc4
Update CONTRIBUTING.md with guidelines about solving issues
samriddhi99 Jul 31, 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
37 changes: 36 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,35 @@ Please use GitHub Discussions to submit feedback and engage with community [http

## Basic guidelines

### Commits

- Use the imperative, present tense («change», not «changed» or «changes») to be consistent with generated messages from commands like git merge.
- Describe the changes you have made

#### Examples
**Good example**:
- Commit Message:\
`Add feature to calculate total monthly cost for AWS resources`

- Description:\
`Implement a function that calculates the total monthly cost for AWS resources. Update the documentation to reflect this new feature.`
refeed marked this conversation as resolved.
Show resolved Hide resolved

Why it’s Good:
> **Clarity**: Clearly states the action and the feature.\
>**Specificity**: Specifies what the feature is and what it affects (AWS resources).\
>**Consistency**: Uses imperative, present tense, aligning with best practices.


**Bad Example**:
- Commit Message:\
`Fixed some stuff`
- Description:\
`Made changes to the code to fix issues. Updated a few things here and there.`
refeed marked this conversation as resolved.
Show resolved Hide resolved
Why it’s Bad:
> **Vague**: Does not explain what was fixed.\
> **Lacks Detail**: Provides no insight into what "stuff" refers to or how it was changed.\
> Does not use imperitve present tense.

### Pull Requests

- **Stay Updated**: Make sure your PR is based on the latest code from the `main` branch.
Expand All @@ -39,12 +68,18 @@ Please use GitHub Discussions to submit feedback and engage with community [http
- **Pass Tests**: Ensure all tests pass before submitting your PR.
- **Be Open to Feedback**: We're all here to help each other improve, so please be open to feedback and ready to make adjustments.

### Issues
### Creating Issues

- **Search First**: It helps to check if your problem or feature request has already been discussed before opening a new issue.
- **Be Detailed**: When you open a new issue, providing as much detail as possible really helps. Feel free to use our templates for bugs and feature requests.
- **Be Respectful**: Let's all be kind and considerate in our communication.

### Solving Issues

- Limit yourself to solving a maximum of four `good first issues`. Once you've reached this limit, consider tackling other types of issues.
- Please work on only one issue at a time.
- Please ask for assignee before working, and if there's no update for about a week on a particular issue, we'll remove the assignee.
refeed marked this conversation as resolved.
Show resolved Hide resolved

Thank you for taking the time to help improve our project!


Expand Down
Loading