Skip to content

Commit 7544143

Browse files
Merge branch 'develop-readme-contributions' into develop. Close #161.
**Description** Ogma now has a process that allows us to accept contributions from external users again. However, the current notice in the README should be updated describing the new process. **Type** - Management: Update to reflect new process. **Additional context** None. **Requester** - Ivan Perez **Method to check presence of bug** Not applicable (not a bug). **Expected result** The README indicates a process by which contributors can send their contributions. **Solution implemented** Modify README to indicate how users can contribute, how to use issues and discussions, how to facilitate making a PR easier to review and merge. **Further notes** I've chosen to leave out the CLAs until users submit the actual PRs, to minimize complexity on their end, since we require quite a few steps already.
2 parents 82bd8ca + e25c7ef commit 7544143

File tree

2 files changed

+32
-7
lines changed

2 files changed

+32
-7
lines changed

ogma-cli/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Revision history for ogma-cli
22

3+
## [1.X.Y] - 2024-11-23
4+
5+
* Update contribution guidelines (#161).
6+
37
## [1.5.0] - 2024-11-21
48

59
* Version bump 1.5.0 (#178).

ogma-cli/README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -517,13 +517,34 @@ individual `x` and `y` fields of a `Point` in a stream.
517517
# Contributions
518518
<sup>[(Back to top)](#table-of-contents)</sup>
519519

520-
The best way to contribute to Ogma is to report any issues you find via the
521-
issue tracker, and to use Ogma to build applications or in your own research
522-
and let us know about your results.
523-
524-
We kindly ask users not to send PRs to this project. Instead, please document
525-
the bugs you find or other suggestions as issues and we will make the necessary
526-
changes.
520+
We'd love to receive your contributions, be it code fixes, new features, bug
521+
reports, discussions, or anything else that can help the Ogma project.
522+
523+
If you have any comments, questions, ideas, or other topics that you think may
524+
be of interest, start a new discussion
525+
[here](https://github.com/nasa/ogma/discussions).
526+
527+
If you would like to contribute a fix for an issue, please comment on the issue
528+
indicating that you want to fix it so that we can assign it to you and track
529+
the status on our end. If the issue does not exist, create it first or ask that
530+
an existing discussion be promoted to an issue.
531+
532+
If you are unsure about whether your submission should be filed as an issue or
533+
as a discussion, file it as a discussion. We can always move it later.
534+
535+
To facilitate merging any pull requests that you send, please:
536+
- Reference the issue you are addressing with the text `Refs #<ISSUENUMBER>.`
537+
at the end of the subject line of each commit message, in *every commit*.
538+
Replace `<ISSUENUMBER>` with the number of the specific issue that your pull
539+
request is addressing.
540+
- Describe what each commit does individually *in the commit's message*. It's
541+
best to err on the side of being more descriptive than less.
542+
- Update the CHANGELOGs in the *last commit(s)*.
543+
544+
You can take a look at the repository's [commit
545+
history](https://github.com/nasa/ogma/commits/develop/) to better
546+
understand the process we follow. Click on each commit to see how we write
547+
commit messages.
527548

528549
# Acknowledgements
529550
<sup>[(Back to top)](#table-of-contents)</sup>

0 commit comments

Comments
 (0)