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.

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

[Feature] Enhancing the Contributing Guide #1034

Conversation

verma-kunal
Copy link
Contributor

With this PR, the existing contributing guide has been revamped with the focus on guiding new contributors on the right path to get involved in the Komiser project!

Few noticeable items added:

  • more structured
  • different ways to contribute (Komiser Engine & UI)
  • best practices while contributing

Reviewers

@jakepage91 @AvineshTripathi

Fixes #1029

Copy link
Contributor

@jakepage91 jakepage91 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there @verma-kunal great work here! I've added a few thoughts

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
```
6. While submitting Pull Request, **make sure to change the base branch from**: [master](https://github.com/tailwarden/komiser/tree/master) to [develop](v). This will ensure to keep your Pull Request away from any conflicts!

> ### Keeping your Fork Up-to-Date
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there is a reason for this whole section to be quoted?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the main reason was to highlight this part actually! because merge conflicts can be confusing especially for beginners, so keeping the fork up to date, before committing new changes is always a good practice and prevents merge conflicts

what do you think?

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@verma-kunal
Copy link
Contributor Author

thanks for the suggestions @jakepage91 ! All resolved ✅

@mlabouardy mlabouardy self-requested a review October 5, 2023 09:42
@mlabouardy mlabouardy added this to the v3.1.2 milestone Oct 5, 2023
@mlabouardy mlabouardy added the docs label Oct 5, 2023
@mlabouardy mlabouardy merged commit 71d6f72 into tailwarden:develop Oct 5, 2023
2 checks passed
@verma-kunal
Copy link
Contributor Author

Thanks @mlabouardy :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update contributing.md
3 participants