diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cfafad20..99037cc4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,5 @@ + # Contributing to UCL ARC Python Recommendations First off, thanks for taking the time to contribute! ❤️ @@ -6,12 +7,14 @@ First off, thanks for taking the time to contribute! ❤️ All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> > - Star the project > - Tweet about it > - Refer this project in your project's readme > - Mention the project at local meetups and tell your friends/colleagues + ## Table of Contents - [I Have a Question](#i-have-a-question) @@ -24,8 +27,6 @@ All types of contributions are encouraged and valued. See the [Table of Contents - [Commit Messages](#commit-messages) - [Join The Project Team](#join-the-project-team) - - ## I Have a Question > If you want to ask a question, we assume that you have read the available [Documentation](https://github-pages.arc.ucl.ac.uk/python-tooling). @@ -58,11 +59,13 @@ Depending on how large the project is, you may want to outsource the questioning ## I Want To Contribute > ### Legal Notice +> > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence. ### Reporting Bugs + #### Before Submitting a Bug Report A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. @@ -79,16 +82,18 @@ A good bug report shouldn't leave others needing to chase you up for more inform - Can you reliably reproduce the issue? And can you also reproduce it with older versions? + #### How Do I Submit a Good Bug Report? > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to . + We use GitHub issues to track bugs and errors. If you run into an issue with the project: - Open an [Issue](https://github.com/UCL-ARC/python-tooling/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) - Explain the behavior you would expect and the actual behavior. -- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. +- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. - Provide the information you collected in the previous section. Once it's filed: @@ -99,12 +104,12 @@ Once it's filed: - ### Suggesting Enhancements This section guides you through submitting an enhancement suggestion for UCL ARC Python Recommendations, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. + #### Before Submitting an Enhancement - Make sure that you are using the latest version. @@ -113,6 +118,7 @@ This section guides you through submitting an enhancement suggestion for UCL ARC - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. + #### How Do I Submit a Good Enhancement Suggestion? Enhancement suggestions are tracked as [GitHub issues](https://github.com/UCL-ARC/python-tooling/issues). @@ -126,26 +132,33 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/UCL-AR ### Your First Code Contribution + ### Improving The Documentation + ## Styleguides + ### Commit Messages + ## Join The Project Team + + ## Attribution + This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!