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

Provide a CONTRIBUTING.md file #581

Closed
miguelcrespo opened this issue Jul 14, 2023 · 1 comment · Fixed by #599
Closed

Provide a CONTRIBUTING.md file #581

miguelcrespo opened this issue Jul 14, 2023 · 1 comment · Fixed by #599
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@miguelcrespo
Copy link

Hi, I was checking out the code of this plugin since I use it a lot and I wanted to understand the code and I notice there's no CONTRIBUTING.md, it might be beneficial to include one to give a brief introduction of how to contribute to this project, some sections I have in mind:

  • Introduction to the project and architecture
  • Code standards
  • How to run the project locally and start developing
@ten3roberts
Copy link
Member

That is a good idea and would further help Neogit becoming an active project.

I'll also add for myself to remember that the todo.txt could be removed as it is mow far from relevant

@ten3roberts ten3roberts self-assigned this Jul 14, 2023
@ten3roberts ten3roberts added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 14, 2023
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants