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

Add a CONTRIBUTING file #28

Closed
Ana06 opened this issue Jun 26, 2020 · 1 comment · Fixed by #114
Closed

Add a CONTRIBUTING file #28

Ana06 opened this issue Jun 26, 2020 · 1 comment · Fixed by #114
Labels
enhancement New feature or request question Further information is requested
Milestone

Comments

@Ana06
Copy link
Member

Ana06 commented Jun 26, 2020

I think we should add a CONTRIBUTING file to collect some important information we now have in other documents. I information is usually in the CONTRIBUTING file in other project and it is where people expect it to be. In addition, it is used by GitHub to help guiding new contributors. For example, when someone opens a pull request or creates an issue, they will see a link to that file:

image

Reference: https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors

I think this document should include the following information:

  • How to contribute with issues, including a reference to the capa-rules repository and which issues belongs to every repo. This should also be linked from the issues template.
  • How to write rules, linking current documentation and explaining the linter
  • How to contribute with code, including how to set the project up (currently in different documents) and how to run the tests.

Something else?

@Ana06 Ana06 added enhancement New feature or request question Further information is requested labels Jun 26, 2020
@williballenthin williballenthin added this to the 1.0 milestone Jul 1, 2020
@williballenthin
Copy link
Collaborator

i like the example used by atom here: https://github.com/atom/atom/blob/master/CONTRIBUTING.md

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants