Skip to content

[WIP] added contributing.md file to assist new contributors #946

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
+135 −0
Open

[WIP] added contributing.md file to assist new contributors #946

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a53f8d8
added contributing.md file to assist new contributors
kernelpanic77 Oct 6, 2022
c8dc4a9
Merge branch 'devfile:main' into contribute
kernelpanic77 Nov 10, 2022
079f79b
Update docs/CONTRIBUTING.md
kernelpanic77 Jan 13, 2023
b171c16
Update docs/CONTRIBUTING.md
kernelpanic77 Jan 13, 2023
a370293
added contributing.md file to assist new contributors
kernelpanic77 Oct 6, 2022
1435065
Update docs/CONTRIBUTING.md
kernelpanic77 Jan 13, 2023
654a59f
Update docs/CONTRIBUTING.md
kernelpanic77 Jan 13, 2023
0c0520a
updated contributing.md
kernelpanic77 Jan 24, 2023
2d9d4c7
updated contributing.md
kernelpanic77 Jan 24, 2023
614092f
changes for contributing.md 'testing controller'
Feb 7, 2023
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
Prev Previous commit
Next Next commit
Update docs/CONTRIBUTING.md 
Co-authored-by: Angel Misevski <[email protected]>
  • Loading branch information
@kernelpanic77 @amisevsk
kernelpanic77 and amisevsk authored Jan 13, 2023
commit b171c164cbf11ea4e02dfaf92053e37b43f66cff
2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Hello there! Thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here.

- [Contributing to Devworkspace-Operator](#contributing-to-devworkspace-operator)
- [Contributing to the DevWorkspace Operator](#contributing-to-devworkspace-operator)
- [Before You Get Started](#before-you-get-started)
- [Code of Conduct](#code-of-conduct)
Copy link
Collaborator

@AObuchow AObuchow Oct 7, 2022

Choose a reason for hiding this comment

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

I'm not sure if you had ideas for the "For Newcomers" section, but if you end up omitting it, it may be worth moving the code of conduct section to the end of this document (or at least, after the "How to Contribute" section).

This is just so that the contributing instructions are immediately visible (as the Code of Conduct section could be a bit lengthy).

Also, if you're looking for inspiration for a code of conduct, here's one

Copy link
Collaborator

@AObuchow AObuchow Oct 13, 2022

Choose a reason for hiding this comment

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

Actually, here's an even better Code of Conduct from the devfile API repo: https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md. It's probably worth making another, separate file for the code of conduct and linking to it in the CONTRIBUTING.md

Copy link
Author

@kernelpanic77 kernelpanic77 Jan 24, 2023

Choose a reason for hiding this comment

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

I am actually omitting the newcomer's section. As it just doesn't seem an immediate requirement for now.

- [For Newcomers](#for-newcomers)
Expand Down