Skip to content

Commit

Permalink
Merge branch 'develop-readme-contributions' into develop. Close #161.
Browse files Browse the repository at this point in the history
**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.
  • Loading branch information
ivanperez-keera committed Nov 25, 2024
2 parents 82bd8ca + e25c7ef commit 7544143
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 7 deletions.
4 changes: 4 additions & 0 deletions ogma-cli/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Revision history for ogma-cli

## [1.X.Y] - 2024-11-23

* Update contribution guidelines (#161).

## [1.5.0] - 2024-11-21

* Version bump 1.5.0 (#178).
Expand Down
35 changes: 28 additions & 7 deletions ogma-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -517,13 +517,34 @@ individual `x` and `y` fields of a `Point` in a stream.
# Contributions
<sup>[(Back to top)](#table-of-contents)</sup>

The best way to contribute to Ogma is to report any issues you find via the
issue tracker, and to use Ogma to build applications or in your own research
and let us know about your results.

We kindly ask users not to send PRs to this project. Instead, please document
the bugs you find or other suggestions as issues and we will make the necessary
changes.
We'd love to receive your contributions, be it code fixes, new features, bug
reports, discussions, or anything else that can help the Ogma project.

If you have any comments, questions, ideas, or other topics that you think may
be of interest, start a new discussion
[here](https://github.com/nasa/ogma/discussions).

If you would like to contribute a fix for an issue, please comment on the issue
indicating that you want to fix it so that we can assign it to you and track
the status on our end. If the issue does not exist, create it first or ask that
an existing discussion be promoted to an issue.

If you are unsure about whether your submission should be filed as an issue or
as a discussion, file it as a discussion. We can always move it later.

To facilitate merging any pull requests that you send, please:
- Reference the issue you are addressing with the text `Refs #<ISSUENUMBER>.`
at the end of the subject line of each commit message, in *every commit*.
Replace `<ISSUENUMBER>` with the number of the specific issue that your pull
request is addressing.
- Describe what each commit does individually *in the commit's message*. It's
best to err on the side of being more descriptive than less.
- Update the CHANGELOGs in the *last commit(s)*.

You can take a look at the repository's [commit
history](https://github.com/nasa/ogma/commits/develop/) to better
understand the process we follow. Click on each commit to see how we write
commit messages.

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

0 comments on commit 7544143

Please sign in to comment.