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

feat: CONTRIBUTING.md #599

Merged
merged 8 commits into from
Jul 18, 2023
Merged

feat: CONTRIBUTING.md #599

merged 8 commits into from
Jul 18, 2023

Conversation

ten3roberts
Copy link
Member

Resolves: #581

@ten3roberts ten3roberts added the documentation Improvements or additions to documentation label Jul 15, 2023
@CKolkey
Copy link
Member

CKolkey commented Jul 15, 2023

Great start. I'd be happy to help expand on the architecture section, unless you want to. The only thing I'd add is more insistence on test coverage.. Thats already showing up as a weak spot with fixes breaking things...

@ten3roberts
Copy link
Member Author

Yes, I'll add that section.

What is the general concensus in markdown? Should proper nouns such as Neogit and Magit be put in Neogit or Neogit, or just plain?

@CKolkey
Copy link
Member

CKolkey commented Jul 15, 2023

Hmm. I don't have a strong feeling on it. I like the backticks, as it makes it stand out nicely, but I'm pretty open to either.

@ten3roberts ten3roberts marked this pull request as ready for review July 18, 2023 08:09
@ten3roberts ten3roberts requested a review from CKolkey July 18, 2023 12:15
@ten3roberts
Copy link
Member Author

I think this should be a good enough starting point for the contributing guide, and over time we'll refine and add more sections to it when we find parts to be unintuitive.

Copy link
Member

@CKolkey CKolkey left a comment

Choose a reason for hiding this comment

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

Great starting point :D

@ten3roberts ten3roberts merged commit fbc5d41 into master Jul 18, 2023
6 checks passed
@ten3roberts ten3roberts deleted the add-contributing branch July 18, 2023 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide a CONTRIBUTING.md file
2 participants