Skip to content

Latest commit

 

History

History
64 lines (53 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

64 lines (53 loc) · 3.14 KB
Raw

Robust Services Core: How to Contribute

Thanks for your interest! This document describes different ways that you can contribute.

Asking a question

Questions are helpful because they can identify where documentation needs to be improved. If you can't find answers there, please email your questions to rsc-questions@pentennea.com.

Collaboration

To contribute in other ways, you need to become a collaborator. To receive an invitation to join the repository, please email your request to rsc-collaborators@pentennea.com, briefly describing your background and areas of interest.

Issues

The other ways to contribute involve the use of GitHub issues, which are labelled as follows:

Label Meaning
application focuses on software in the mb, cb, pots, sn, an, rn, or on directory
blocked another item needs to be completed before this one
bug a problem that needs to be fixed
core focuses on software in the nb, nw, sb, cn, or rsc directory
core tools focuses on software in the nt or st directory
c++ tools focuses on software in the ct or subs directory
design discussed in RSC Software Design
documentation additions or changes to documents or code comments
duplicate already described in another issue
enhancement a capability that should be added
good first issue suggestions for new contributors
help wanted an issue where collaboration is especially sought
invalid/declined will not be implemented
question something that should be added to a FAQ
1 a day's effort once reasonably familiar with the software
2 several day's effort once reasonably familiar with the software
3 around a week's effort once reasonably familiar with the software
4 several week's effort once reasonbly familiar with the software
5 a major project

If you're a new contributor, you may want to start with an item labelled good first issue.

When creating an issue

  • Choose a descriptive title and appropriate labels.
  • If you plan to work on the issue, provide enough detail so that others can understand what you plan to achieve.
  • If you don't plan to work on the issue, provide enough detail so that what gets implemented will be what you wanted.

Reporting a bug

Describe what you did and how the results differed from what you expected. Attach a console file and log file. If possible, also attach a test script that can be >read from the console, along with the output from a trace tool.

Suggesting an enhancement

Describe the expected behavior. Unless it is obvious why the new capability would be beneficial, include a rationale and/or examples of how it would be used. If you have ideas about how to implement it, include some high-level design notes.

Writing code

Before working on code

  • Please sign the contributor agreement and email it to us.
  • Make sure that the change has been documented as an issue.
  • Ask to be assigned to the issue so that other contributors can see what is being worked on.
  • Read the documents that are relevant to the code that you will be writing.