First off, thanks for contemplating contributing to work for the Automation Working Group!
The following is a set of guidelines for contributing and are by no means set in stone so please your best judgment, and feel free to propose changes to this document in a pull request.
I don't want to read this whole thing, I just have a question!!!
What should I know before I get started?
This project and everyone participating in it is governed by Github's most minimal Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior in a direct message to @mattrbianchi.
Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.
You can join the AWG Gitter chat.
- Even though Gitter is a chat service, sometimes it takes several hours for community members to respond — please be patient!
When we make a significant decision in how we maintain the project and what we can or cannot support, we will document it in cve-services-doc. If you have a question around how we do things, check to see if it is documented there. If it is not documented there, please join the AWG Gitter chat and ask your question.
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- **Check the logs.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. Provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Atom, e.g. which command exactly you used in the terminal, or how you started Atom otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Atom command, and if so which one?
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which version of the API are you using?
- What's the name and version of the OS you're using?
This section guides you through submitting a code proposal for CVE services, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your proposal and find related suggestions.
Before creating a code proposal, please check this list as you might find out that you don't need to create one. When you are creating a code proposal, please fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
Enhancement suggestions are tracked as GitHub issues. Please make sure to provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps when applicable. Include copy/paste-able snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why (if applicable).
- Explain why this enhancement would be useful to most users and isn't something that can or should be implemented as an outside service that just integrates with the API.
Unsure where to begin contributing? You can start by looking through these good first issue labels:
- good first issue - issues which should only require a few lines of code, and a test or two.
If diving head first still seems daunting, the development team will be holding a designated office hour every Monday on the AWG Gitter chat 3-4PM (EST/EDT) for pre-sprint planning. All that are interested in contributing to the project can come into the room to see what we plan to work on in the coming sprint.
This project aims to follow the git flow model of branching. Adding the issue in the branch name (#1 or issue-1) makes it easier to tie the branch to defined work.
An additional best practice is to create a pull request after creating the branch but before getting started on development. This helps inform maintainers and other contributors that work has started on an issue, decreasing the chance someone else picks it up. The PR title should be prefixed with WIP (Work In Progress) so reviewers know the PR is not ready for review.
The process described here has several goals:
- Maintain quality
- Fix problems that are important to users
- Engage the community in working toward the best possible solutions
- Enable a sustainable system for maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
All JavaScript must adhere to JavaScript Standard Style.
- Include thoughtfully-worded, well-structured Mocha specs in the
./specfolder. - Treat
describeas a noun or situation. - Treat
itas a statement about state or how an operation changes state.
- Use ApiDoc.