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

Update information for contributions #127

Closed
tallamjr opened this issue May 8, 2019 · 0 comments
Closed

Update information for contributions #127

tallamjr opened this issue May 8, 2019 · 0 comments
Assignees
Labels
documentation Updates to documentation required pre-v2.0.0 Issues that should be completed prior to public release of v2.0.0

Comments

@tallamjr
Copy link
Collaborator

tallamjr commented May 8, 2019

Proposed here is to move the /snmachine/docs/contributing/conventions_for_pushes.md to a single CONTRIBUTING.md file at the top level of the repo which is the common location for many open source projects.

Currently there is a description for code style, but this could be moved to Code Style sub-heading and other topics included such as;

  • Creating an Issue
  • Submitting a Pull Request
  • Running Tests Locally
  • Package Versioning
    ... etc

This can potentially also link to #126

@tallamjr tallamjr added the pre-v2.0.0 Issues that should be completed prior to public release of v2.0.0 label May 8, 2019
@tallamjr tallamjr self-assigned this May 8, 2019
@tallamjr tallamjr added the documentation Updates to documentation required label May 8, 2019
tallamjr added a commit that referenced this issue May 9, 2019
In addition to Code Style section, further subsections have been added
such as:

	* Creating an Issue
	* Submitting a Pull Request
	* Running Tests Locally
	* Package Versioning]

Some sections anticipate adoption of certain practises that have not
been implemented yet, such as CHANGELOG, but this should be in place in
due course. Therefore this commit links to #129

Closes #127
tallamjr added a commit that referenced this issue May 9, 2019
In addition to Code Style section, further subsections have been added
such as:

	* Creating an Issue
	* Submitting a Pull Request
	* Running Tests Locally
	* Package Versioning

Some sections anticipate adoption of certain practises that have not
been implemented yet, such as CHANGELOG, but this should be in place in
due course. Therefore this commit links to #129

Closes #127
tallamjr added a commit that referenced this issue May 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Updates to documentation required pre-v2.0.0 Issues that should be completed prior to public release of v2.0.0
Projects
None yet
Development

No branches or pull requests

1 participant